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