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 document library file version with the primary key.
188            *
189            * @param fileVersionId the primary key of the document library file version
190            * @return the document library file version
191            * @throws PortalException if a document library file version with the primary key could not be found
192            */
193            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
194            public com.liferay.portlet.documentlibrary.model.DLFileVersion getDLFileVersion(
195                    long fileVersionId) throws PortalException;
196    
197            /**
198            * Returns the document library file version matching the UUID and group.
199            *
200            * @param uuid the document library file version's UUID
201            * @param groupId the primary key of the group
202            * @return the matching document library file version
203            * @throws PortalException if a matching document library file version could not be found
204            */
205            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
206            public com.liferay.portlet.documentlibrary.model.DLFileVersion getDLFileVersionByUuidAndGroupId(
207                    java.lang.String uuid, long groupId) throws PortalException;
208    
209            /**
210            * Returns a range of all the document library file versions.
211            *
212            * <p>
213            * 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.
214            * </p>
215            *
216            * @param start the lower bound of the range of document library file versions
217            * @param end the upper bound of the range of document library file versions (not inclusive)
218            * @return the range of document library file versions
219            */
220            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
221            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileVersion> getDLFileVersions(
222                    int start, int end);
223    
224            /**
225            * Returns all the document library file versions matching the UUID and company.
226            *
227            * @param uuid the UUID of the document library file versions
228            * @param companyId the primary key of the company
229            * @return the matching document library file versions, or an empty list if no matches were found
230            */
231            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
232            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileVersion> getDLFileVersionsByUuidAndCompanyId(
233                    java.lang.String uuid, long companyId);
234    
235            /**
236            * Returns a range of document library file versions matching the UUID and company.
237            *
238            * @param uuid the UUID of the document library file versions
239            * @param companyId the primary key of the company
240            * @param start the lower bound of the range of document library file versions
241            * @param end the upper bound of the range of document library file versions (not inclusive)
242            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
243            * @return the range of matching document library file versions, or an empty list if no matches were found
244            */
245            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
246            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileVersion> getDLFileVersionsByUuidAndCompanyId(
247                    java.lang.String uuid, long companyId, int start, int end,
248                    com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.documentlibrary.model.DLFileVersion> orderByComparator);
249    
250            /**
251            * Returns the number of document library file versions.
252            *
253            * @return the number of document library file versions
254            */
255            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
256            public int getDLFileVersionsCount();
257    
258            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
259            public com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(
260                    com.liferay.portlet.exportimport.lar.PortletDataContext portletDataContext);
261    
262            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
263            public com.liferay.portlet.documentlibrary.model.DLFileVersion getFileVersion(
264                    long fileEntryId, java.lang.String version) throws PortalException;
265    
266            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
267            public com.liferay.portlet.documentlibrary.model.DLFileVersion getFileVersion(
268                    long fileVersionId) throws PortalException;
269    
270            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
271            public com.liferay.portlet.documentlibrary.model.DLFileVersion getFileVersionByUuidAndGroupId(
272                    java.lang.String uuid, long groupId);
273    
274            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
275            public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileVersion> getFileVersions(
276                    long fileEntryId, int status);
277    
278            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
279            public int getFileVersionsCount(long fileEntryId, int status);
280    
281            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
282            public com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
283    
284            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
285            public com.liferay.portlet.documentlibrary.model.DLFileVersion getLatestFileVersion(
286                    long fileEntryId, boolean excludeWorkingCopy) throws PortalException;
287    
288            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
289            public com.liferay.portlet.documentlibrary.model.DLFileVersion getLatestFileVersion(
290                    long userId, long fileEntryId) throws PortalException;
291    
292            /**
293            * Returns the OSGi service identifier.
294            *
295            * @return the OSGi service identifier
296            */
297            public java.lang.String getOSGiServiceIdentifier();
298    
299            @Override
300            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
301            public com.liferay.portal.model.PersistedModel getPersistedModel(
302                    java.io.Serializable primaryKeyObj) throws PortalException;
303    
304            public void rebuildTree(long companyId) throws PortalException;
305    
306            public void setTreePaths(long folderId, java.lang.String treePath)
307                    throws PortalException;
308    
309            /**
310            * Updates the document library file version in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
311            *
312            * @param dlFileVersion the document library file version
313            * @return the document library file version that was updated
314            */
315            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
316            public com.liferay.portlet.documentlibrary.model.DLFileVersion updateDLFileVersion(
317                    com.liferay.portlet.documentlibrary.model.DLFileVersion dlFileVersion);
318    }