001 /** 002 * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved. 003 * 004 * This library is free software; you can redistribute it and/or modify it under 005 * the terms of the GNU Lesser General Public License as published by the Free 006 * Software Foundation; either version 2.1 of the License, or (at your option) 007 * any later version. 008 * 009 * This library is distributed in the hope that it will be useful, but WITHOUT 010 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 011 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more 012 * details. 013 */ 014 015 package com.liferay.portlet.documentlibrary.service; 016 017 import aQute.bnd.annotation.ProviderType; 018 019 import com.liferay.portal.kernel.exception.PortalException; 020 import com.liferay.portal.kernel.exception.SystemException; 021 import com.liferay.portal.kernel.search.IndexableType; 022 import com.liferay.portal.kernel.transaction.Isolation; 023 import com.liferay.portal.kernel.transaction.Propagation; 024 import com.liferay.portal.kernel.transaction.Transactional; 025 import com.liferay.portal.service.BaseLocalService; 026 import com.liferay.portal.service.PersistedModelLocalService; 027 028 /** 029 * Provides the local service interface for DLFileVersion. Methods of this 030 * service will not have security checks based on the propagated JAAS 031 * credentials because this service can only be accessed from within the same 032 * VM. 033 * 034 * @author Brian Wing Shun Chan 035 * @see DLFileVersionLocalServiceUtil 036 * @see com.liferay.portlet.documentlibrary.service.base.DLFileVersionLocalServiceBaseImpl 037 * @see com.liferay.portlet.documentlibrary.service.impl.DLFileVersionLocalServiceImpl 038 * @generated 039 */ 040 @ProviderType 041 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 042 PortalException.class, SystemException.class}) 043 public interface DLFileVersionLocalService extends BaseLocalService, 044 PersistedModelLocalService { 045 /* 046 * NOTE FOR DEVELOPERS: 047 * 048 * Never modify or reference this interface directly. Always use {@link DLFileVersionLocalServiceUtil} to access the document library file version local service. Add custom service methods to {@link com.liferay.portlet.documentlibrary.service.impl.DLFileVersionLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 049 */ 050 051 /** 052 * Adds the document library file version to the database. Also notifies the appropriate model listeners. 053 * 054 * @param dlFileVersion the document library file version 055 * @return the document library file version that was added 056 * @throws SystemException if a system exception occurred 057 */ 058 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 059 public com.liferay.portlet.documentlibrary.model.DLFileVersion addDLFileVersion( 060 com.liferay.portlet.documentlibrary.model.DLFileVersion dlFileVersion) 061 throws com.liferay.portal.kernel.exception.SystemException; 062 063 /** 064 * Creates a new document library file version with the primary key. Does not add the document library file version to the database. 065 * 066 * @param fileVersionId the primary key for the new document library file version 067 * @return the new document library file version 068 */ 069 public com.liferay.portlet.documentlibrary.model.DLFileVersion createDLFileVersion( 070 long fileVersionId); 071 072 /** 073 * Deletes the document library file version with the primary key from the database. Also notifies the appropriate model listeners. 074 * 075 * @param fileVersionId the primary key of the document library file version 076 * @return the document library file version that was removed 077 * @throws PortalException if a document library file version with the primary key could not be found 078 * @throws SystemException if a system exception occurred 079 */ 080 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 081 public com.liferay.portlet.documentlibrary.model.DLFileVersion deleteDLFileVersion( 082 long fileVersionId) 083 throws com.liferay.portal.kernel.exception.PortalException, 084 com.liferay.portal.kernel.exception.SystemException; 085 086 /** 087 * Deletes the document library file version from the database. Also notifies the appropriate model listeners. 088 * 089 * @param dlFileVersion the document library file version 090 * @return the document library file version that was removed 091 * @throws SystemException if a system exception occurred 092 */ 093 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 094 public com.liferay.portlet.documentlibrary.model.DLFileVersion deleteDLFileVersion( 095 com.liferay.portlet.documentlibrary.model.DLFileVersion dlFileVersion) 096 throws com.liferay.portal.kernel.exception.SystemException; 097 098 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 099 100 /** 101 * Performs a dynamic query on the database and returns the matching rows. 102 * 103 * @param dynamicQuery the dynamic query 104 * @return the matching rows 105 * @throws SystemException if a system exception occurred 106 */ 107 @SuppressWarnings("rawtypes") 108 public java.util.List dynamicQuery( 109 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 110 throws com.liferay.portal.kernel.exception.SystemException; 111 112 /** 113 * Performs a dynamic query on the database and returns a range of the matching rows. 114 * 115 * <p> 116 * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.documentlibrary.model.impl.DLFileVersionModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 117 * </p> 118 * 119 * @param dynamicQuery the dynamic query 120 * @param start the lower bound of the range of model instances 121 * @param end the upper bound of the range of model instances (not inclusive) 122 * @return the range of matching rows 123 * @throws SystemException if a system exception occurred 124 */ 125 @SuppressWarnings("rawtypes") 126 public java.util.List dynamicQuery( 127 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 128 int end) throws com.liferay.portal.kernel.exception.SystemException; 129 130 /** 131 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 132 * 133 * <p> 134 * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.documentlibrary.model.impl.DLFileVersionModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 135 * </p> 136 * 137 * @param dynamicQuery the dynamic query 138 * @param start the lower bound of the range of model instances 139 * @param end the upper bound of the range of model instances (not inclusive) 140 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 141 * @return the ordered range of matching rows 142 * @throws SystemException if a system exception occurred 143 */ 144 @SuppressWarnings("rawtypes") 145 public java.util.List dynamicQuery( 146 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 147 int end, 148 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 149 throws com.liferay.portal.kernel.exception.SystemException; 150 151 /** 152 * Returns the number of rows that match the dynamic query. 153 * 154 * @param dynamicQuery the dynamic query 155 * @return the number of rows that match the dynamic query 156 * @throws SystemException if a system exception occurred 157 */ 158 public long dynamicQueryCount( 159 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 160 throws com.liferay.portal.kernel.exception.SystemException; 161 162 /** 163 * Returns the number of rows that match the dynamic query. 164 * 165 * @param dynamicQuery the dynamic query 166 * @param projection the projection to apply to the query 167 * @return the number of rows that match the dynamic query 168 * @throws SystemException if a system exception occurred 169 */ 170 public long dynamicQueryCount( 171 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 172 com.liferay.portal.kernel.dao.orm.Projection projection) 173 throws com.liferay.portal.kernel.exception.SystemException; 174 175 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 176 public com.liferay.portlet.documentlibrary.model.DLFileVersion fetchDLFileVersion( 177 long fileVersionId) 178 throws com.liferay.portal.kernel.exception.SystemException; 179 180 /** 181 * Returns the document library file version with the matching UUID and company. 182 * 183 * @param uuid the document library file version's UUID 184 * @param companyId the primary key of the company 185 * @return the matching document library file version, or <code>null</code> if a matching document library file version could not be found 186 * @throws SystemException if a system exception occurred 187 */ 188 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 189 public com.liferay.portlet.documentlibrary.model.DLFileVersion fetchDLFileVersionByUuidAndCompanyId( 190 java.lang.String uuid, long companyId) 191 throws com.liferay.portal.kernel.exception.SystemException; 192 193 /** 194 * Returns the document library file version matching the UUID and group. 195 * 196 * @param uuid the document library file version's UUID 197 * @param groupId the primary key of the group 198 * @return the matching document library file version, or <code>null</code> if a matching document library file version could not be found 199 * @throws SystemException if a system exception occurred 200 */ 201 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 202 public com.liferay.portlet.documentlibrary.model.DLFileVersion fetchDLFileVersionByUuidAndGroupId( 203 java.lang.String uuid, long groupId) 204 throws com.liferay.portal.kernel.exception.SystemException; 205 206 /** 207 * Returns the document library file version with the primary key. 208 * 209 * @param fileVersionId the primary key of the document library file version 210 * @return the document library file version 211 * @throws PortalException if a document library file version with the primary key could not be found 212 * @throws SystemException if a system exception occurred 213 */ 214 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 215 public com.liferay.portlet.documentlibrary.model.DLFileVersion getDLFileVersion( 216 long fileVersionId) 217 throws com.liferay.portal.kernel.exception.PortalException, 218 com.liferay.portal.kernel.exception.SystemException; 219 220 @Override 221 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 222 public com.liferay.portal.model.PersistedModel getPersistedModel( 223 java.io.Serializable primaryKeyObj) 224 throws com.liferay.portal.kernel.exception.PortalException, 225 com.liferay.portal.kernel.exception.SystemException; 226 227 /** 228 * Returns the document library file version with the matching UUID and company. 229 * 230 * @param uuid the document library file version's UUID 231 * @param companyId the primary key of the company 232 * @return the matching document library file version 233 * @throws PortalException if a matching document library file version could not be found 234 * @throws SystemException if a system exception occurred 235 */ 236 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 237 public com.liferay.portlet.documentlibrary.model.DLFileVersion getDLFileVersionByUuidAndCompanyId( 238 java.lang.String uuid, long companyId) 239 throws com.liferay.portal.kernel.exception.PortalException, 240 com.liferay.portal.kernel.exception.SystemException; 241 242 /** 243 * Returns the document library file version matching the UUID and group. 244 * 245 * @param uuid the document library file version's UUID 246 * @param groupId the primary key of the group 247 * @return the matching document library file version 248 * @throws PortalException if a matching document library file version could not be found 249 * @throws SystemException if a system exception occurred 250 */ 251 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 252 public com.liferay.portlet.documentlibrary.model.DLFileVersion getDLFileVersionByUuidAndGroupId( 253 java.lang.String uuid, long groupId) 254 throws com.liferay.portal.kernel.exception.PortalException, 255 com.liferay.portal.kernel.exception.SystemException; 256 257 /** 258 * Returns a range of all the document library file versions. 259 * 260 * <p> 261 * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.documentlibrary.model.impl.DLFileVersionModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 262 * </p> 263 * 264 * @param start the lower bound of the range of document library file versions 265 * @param end the upper bound of the range of document library file versions (not inclusive) 266 * @return the range of document library file versions 267 * @throws SystemException if a system exception occurred 268 */ 269 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 270 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileVersion> getDLFileVersions( 271 int start, int end) 272 throws com.liferay.portal.kernel.exception.SystemException; 273 274 /** 275 * Returns the number of document library file versions. 276 * 277 * @return the number of document library file versions 278 * @throws SystemException if a system exception occurred 279 */ 280 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 281 public int getDLFileVersionsCount() 282 throws com.liferay.portal.kernel.exception.SystemException; 283 284 /** 285 * Updates the document library file version in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 286 * 287 * @param dlFileVersion the document library file version 288 * @return the document library file version that was updated 289 * @throws SystemException if a system exception occurred 290 */ 291 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 292 public com.liferay.portlet.documentlibrary.model.DLFileVersion updateDLFileVersion( 293 com.liferay.portlet.documentlibrary.model.DLFileVersion dlFileVersion) 294 throws com.liferay.portal.kernel.exception.SystemException; 295 296 /** 297 * Returns the Spring bean ID for this bean. 298 * 299 * @return the Spring bean ID for this bean 300 */ 301 public java.lang.String getBeanIdentifier(); 302 303 /** 304 * Sets the Spring bean ID for this bean. 305 * 306 * @param beanIdentifier the Spring bean ID for this bean 307 */ 308 public void setBeanIdentifier(java.lang.String beanIdentifier); 309 310 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 311 public com.liferay.portlet.documentlibrary.model.DLFileVersion getFileVersion( 312 long fileVersionId) 313 throws com.liferay.portal.kernel.exception.PortalException, 314 com.liferay.portal.kernel.exception.SystemException; 315 316 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 317 public com.liferay.portlet.documentlibrary.model.DLFileVersion getFileVersion( 318 long fileEntryId, java.lang.String version) 319 throws com.liferay.portal.kernel.exception.PortalException, 320 com.liferay.portal.kernel.exception.SystemException; 321 322 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 323 public com.liferay.portlet.documentlibrary.model.DLFileVersion getFileVersionByUuidAndGroupId( 324 java.lang.String uuid, long groupId) 325 throws com.liferay.portal.kernel.exception.SystemException; 326 327 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 328 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileVersion> getFileVersions( 329 long fileEntryId, int status) 330 throws com.liferay.portal.kernel.exception.SystemException; 331 332 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 333 public int getFileVersionsCount(long fileEntryId, int status) 334 throws com.liferay.portal.kernel.exception.SystemException; 335 336 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 337 public com.liferay.portlet.documentlibrary.model.DLFileVersion getLatestFileVersion( 338 long fileEntryId, boolean excludeWorkingCopy) 339 throws com.liferay.portal.kernel.exception.PortalException, 340 com.liferay.portal.kernel.exception.SystemException; 341 342 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 343 public com.liferay.portlet.documentlibrary.model.DLFileVersion getLatestFileVersion( 344 long userId, long fileEntryId) 345 throws com.liferay.portal.kernel.exception.PortalException, 346 com.liferay.portal.kernel.exception.SystemException; 347 348 public void rebuildTree(long companyId) 349 throws com.liferay.portal.kernel.exception.PortalException, 350 com.liferay.portal.kernel.exception.SystemException; 351 352 public void setTreePaths(long folderId, java.lang.String treePath) 353 throws com.liferay.portal.kernel.exception.PortalException, 354 com.liferay.portal.kernel.exception.SystemException; 355 }