001 /** 002 * Copyright (c) 2000-present 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 */ 057 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 058 public com.liferay.portlet.documentlibrary.model.DLFileVersion addDLFileVersion( 059 com.liferay.portlet.documentlibrary.model.DLFileVersion dlFileVersion); 060 061 /** 062 * Creates a new document library file version with the primary key. Does not add the document library file version to the database. 063 * 064 * @param fileVersionId the primary key for the new document library file version 065 * @return the new document library file version 066 */ 067 public com.liferay.portlet.documentlibrary.model.DLFileVersion createDLFileVersion( 068 long fileVersionId); 069 070 /** 071 * Deletes the document library file version from the database. Also notifies the appropriate model listeners. 072 * 073 * @param dlFileVersion the document library file version 074 * @return the document library file version that was removed 075 */ 076 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 077 public com.liferay.portlet.documentlibrary.model.DLFileVersion deleteDLFileVersion( 078 com.liferay.portlet.documentlibrary.model.DLFileVersion dlFileVersion); 079 080 /** 081 * Deletes the document library file version with the primary key from the database. Also notifies the appropriate model listeners. 082 * 083 * @param fileVersionId the primary key of the document library file version 084 * @return the document library file version that was removed 085 * @throws PortalException if a document library file version with the primary key could not be found 086 */ 087 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 088 public com.liferay.portlet.documentlibrary.model.DLFileVersion deleteDLFileVersion( 089 long fileVersionId) 090 throws com.liferay.portal.kernel.exception.PortalException; 091 092 /** 093 * @throws PortalException 094 */ 095 @Override 096 public com.liferay.portal.model.PersistedModel deletePersistedModel( 097 com.liferay.portal.model.PersistedModel persistedModel) 098 throws com.liferay.portal.kernel.exception.PortalException; 099 100 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 101 102 /** 103 * Performs a dynamic query on the database and returns the matching rows. 104 * 105 * @param dynamicQuery the dynamic query 106 * @return the matching rows 107 */ 108 public <T> java.util.List<T> dynamicQuery( 109 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 110 111 /** 112 * Performs a dynamic query on the database and returns a range of the matching rows. 113 * 114 * <p> 115 * 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. 116 * </p> 117 * 118 * @param dynamicQuery the dynamic query 119 * @param start the lower bound of the range of model instances 120 * @param end the upper bound of the range of model instances (not inclusive) 121 * @return the range of matching rows 122 */ 123 public <T> java.util.List<T> dynamicQuery( 124 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 125 int end); 126 127 /** 128 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 129 * 130 * <p> 131 * 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. 132 * </p> 133 * 134 * @param dynamicQuery the dynamic query 135 * @param start the lower bound of the range of model instances 136 * @param end the upper bound of the range of model instances (not inclusive) 137 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 138 * @return the ordered range of matching rows 139 */ 140 public <T> java.util.List<T> dynamicQuery( 141 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 142 int end, 143 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 144 145 /** 146 * Returns the number of rows that match the dynamic query. 147 * 148 * @param dynamicQuery the dynamic query 149 * @return the number of rows that match the dynamic query 150 */ 151 public long dynamicQueryCount( 152 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 153 154 /** 155 * Returns the number of rows that match the dynamic query. 156 * 157 * @param dynamicQuery the dynamic query 158 * @param projection the projection to apply to the query 159 * @return the number of rows that match the dynamic query 160 */ 161 public long dynamicQueryCount( 162 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 163 com.liferay.portal.kernel.dao.orm.Projection projection); 164 165 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 166 public com.liferay.portlet.documentlibrary.model.DLFileVersion fetchDLFileVersion( 167 long fileVersionId); 168 169 /** 170 * Returns the document library file version matching the UUID and group. 171 * 172 * @param uuid the document library file version's UUID 173 * @param groupId the primary key of the group 174 * @return the matching document library file version, or <code>null</code> if a matching document library file version could not be found 175 */ 176 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 177 public com.liferay.portlet.documentlibrary.model.DLFileVersion fetchDLFileVersionByUuidAndGroupId( 178 java.lang.String uuid, long groupId); 179 180 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 181 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 182 183 /** 184 * Returns the Spring bean ID for this bean. 185 * 186 * @return the Spring bean ID for this bean 187 */ 188 public java.lang.String getBeanIdentifier(); 189 190 /** 191 * Returns the document library file version with the primary key. 192 * 193 * @param fileVersionId the primary key of the document library file version 194 * @return the document library file version 195 * @throws PortalException if a document library file version with the primary key could not be found 196 */ 197 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 198 public com.liferay.portlet.documentlibrary.model.DLFileVersion getDLFileVersion( 199 long fileVersionId) 200 throws com.liferay.portal.kernel.exception.PortalException; 201 202 /** 203 * Returns the document library file version matching the UUID and group. 204 * 205 * @param uuid the document library file version's UUID 206 * @param groupId the primary key of the group 207 * @return the matching document library file version 208 * @throws PortalException if a matching document library file version could not be found 209 */ 210 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 211 public com.liferay.portlet.documentlibrary.model.DLFileVersion getDLFileVersionByUuidAndGroupId( 212 java.lang.String uuid, long groupId) 213 throws com.liferay.portal.kernel.exception.PortalException; 214 215 /** 216 * Returns a range of all the document library file versions. 217 * 218 * <p> 219 * 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. 220 * </p> 221 * 222 * @param start the lower bound of the range of document library file versions 223 * @param end the upper bound of the range of document library file versions (not inclusive) 224 * @return the range of document library file versions 225 */ 226 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 227 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileVersion> getDLFileVersions( 228 int start, int end); 229 230 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 231 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileVersion> getDLFileVersionsByUuidAndCompanyId( 232 java.lang.String uuid, long companyId); 233 234 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 235 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileVersion> getDLFileVersionsByUuidAndCompanyId( 236 java.lang.String uuid, long companyId, int start, int end, 237 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.documentlibrary.model.DLFileVersion> orderByComparator); 238 239 /** 240 * Returns the number of document library file versions. 241 * 242 * @return the number of document library file versions 243 */ 244 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 245 public int getDLFileVersionsCount(); 246 247 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 248 public com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery( 249 com.liferay.portal.kernel.lar.PortletDataContext portletDataContext); 250 251 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 252 public com.liferay.portlet.documentlibrary.model.DLFileVersion getFileVersion( 253 long fileEntryId, java.lang.String version) 254 throws com.liferay.portal.kernel.exception.PortalException; 255 256 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 257 public com.liferay.portlet.documentlibrary.model.DLFileVersion getFileVersion( 258 long fileVersionId) 259 throws com.liferay.portal.kernel.exception.PortalException; 260 261 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 262 public com.liferay.portlet.documentlibrary.model.DLFileVersion getFileVersionByUuidAndGroupId( 263 java.lang.String uuid, long groupId); 264 265 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 266 public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileVersion> getFileVersions( 267 long fileEntryId, int status); 268 269 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 270 public int getFileVersionsCount(long fileEntryId, int status); 271 272 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 273 public com.liferay.portlet.documentlibrary.model.DLFileVersion getLatestFileVersion( 274 long fileEntryId, boolean excludeWorkingCopy) 275 throws com.liferay.portal.kernel.exception.PortalException; 276 277 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 278 public com.liferay.portlet.documentlibrary.model.DLFileVersion getLatestFileVersion( 279 long userId, long fileEntryId) 280 throws com.liferay.portal.kernel.exception.PortalException; 281 282 @Override 283 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 284 public com.liferay.portal.model.PersistedModel getPersistedModel( 285 java.io.Serializable primaryKeyObj) 286 throws com.liferay.portal.kernel.exception.PortalException; 287 288 public void rebuildTree(long companyId) 289 throws com.liferay.portal.kernel.exception.PortalException; 290 291 /** 292 * Sets the Spring bean ID for this bean. 293 * 294 * @param beanIdentifier the Spring bean ID for this bean 295 */ 296 public void setBeanIdentifier(java.lang.String beanIdentifier); 297 298 public void setTreePaths(long folderId, java.lang.String treePath) 299 throws com.liferay.portal.kernel.exception.PortalException; 300 301 /** 302 * Updates the document library file version in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 303 * 304 * @param dlFileVersion the document library file version 305 * @return the document library file version that was updated 306 */ 307 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 308 public com.liferay.portlet.documentlibrary.model.DLFileVersion updateDLFileVersion( 309 com.liferay.portlet.documentlibrary.model.DLFileVersion dlFileVersion); 310 }