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.bean.PortalBeanLocatorUtil;
020    import com.liferay.portal.kernel.util.ReferenceRegistry;
021    
022    /**
023     * Provides the local service utility for DLFileVersion. This utility wraps
024     * {@link com.liferay.portlet.documentlibrary.service.impl.DLFileVersionLocalServiceImpl} and is the
025     * primary access point for service operations in application layer code running
026     * on the local server. Methods of this service will not have security checks
027     * based on the propagated JAAS credentials because this service can only be
028     * accessed from within the same VM.
029     *
030     * @author Brian Wing Shun Chan
031     * @see DLFileVersionLocalService
032     * @see com.liferay.portlet.documentlibrary.service.base.DLFileVersionLocalServiceBaseImpl
033     * @see com.liferay.portlet.documentlibrary.service.impl.DLFileVersionLocalServiceImpl
034     * @generated
035     */
036    @ProviderType
037    public class DLFileVersionLocalServiceUtil {
038            /*
039             * NOTE FOR DEVELOPERS:
040             *
041             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.documentlibrary.service.impl.DLFileVersionLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
042             */
043    
044            /**
045            * Adds the document library file version to the database. Also notifies the appropriate model listeners.
046            *
047            * @param dlFileVersion the document library file version
048            * @return the document library file version that was added
049            */
050            public static com.liferay.portlet.documentlibrary.model.DLFileVersion addDLFileVersion(
051                    com.liferay.portlet.documentlibrary.model.DLFileVersion dlFileVersion) {
052                    return getService().addDLFileVersion(dlFileVersion);
053            }
054    
055            /**
056            * Creates a new document library file version with the primary key. Does not add the document library file version to the database.
057            *
058            * @param fileVersionId the primary key for the new document library file version
059            * @return the new document library file version
060            */
061            public static com.liferay.portlet.documentlibrary.model.DLFileVersion createDLFileVersion(
062                    long fileVersionId) {
063                    return getService().createDLFileVersion(fileVersionId);
064            }
065    
066            /**
067            * Deletes the document library file version from the database. Also notifies the appropriate model listeners.
068            *
069            * @param dlFileVersion the document library file version
070            * @return the document library file version that was removed
071            */
072            public static com.liferay.portlet.documentlibrary.model.DLFileVersion deleteDLFileVersion(
073                    com.liferay.portlet.documentlibrary.model.DLFileVersion dlFileVersion) {
074                    return getService().deleteDLFileVersion(dlFileVersion);
075            }
076    
077            /**
078            * Deletes the document library file version with the primary key from the database. Also notifies the appropriate model listeners.
079            *
080            * @param fileVersionId the primary key of the document library file version
081            * @return the document library file version that was removed
082            * @throws PortalException if a document library file version with the primary key could not be found
083            */
084            public static com.liferay.portlet.documentlibrary.model.DLFileVersion deleteDLFileVersion(
085                    long fileVersionId)
086                    throws com.liferay.portal.kernel.exception.PortalException {
087                    return getService().deleteDLFileVersion(fileVersionId);
088            }
089    
090            /**
091            * @throws PortalException
092            */
093            public static com.liferay.portal.model.PersistedModel deletePersistedModel(
094                    com.liferay.portal.model.PersistedModel persistedModel)
095                    throws com.liferay.portal.kernel.exception.PortalException {
096                    return getService().deletePersistedModel(persistedModel);
097            }
098    
099            public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
100                    return getService().dynamicQuery();
101            }
102    
103            /**
104            * Performs a dynamic query on the database and returns the matching rows.
105            *
106            * @param dynamicQuery the dynamic query
107            * @return the matching rows
108            */
109            public static <T> java.util.List<T> dynamicQuery(
110                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) {
111                    return getService().dynamicQuery(dynamicQuery);
112            }
113    
114            /**
115            * Performs a dynamic query on the database and returns a range of the matching rows.
116            *
117            * <p>
118            * 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.
119            * </p>
120            *
121            * @param dynamicQuery the dynamic query
122            * @param start the lower bound of the range of model instances
123            * @param end the upper bound of the range of model instances (not inclusive)
124            * @return the range of matching rows
125            */
126            public static <T> java.util.List<T> dynamicQuery(
127                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
128                    int end) {
129                    return getService().dynamicQuery(dynamicQuery, start, end);
130            }
131    
132            /**
133            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
134            *
135            * <p>
136            * 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.
137            * </p>
138            *
139            * @param dynamicQuery the dynamic query
140            * @param start the lower bound of the range of model instances
141            * @param end the upper bound of the range of model instances (not inclusive)
142            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
143            * @return the ordered range of matching rows
144            */
145            public static <T> java.util.List<T> dynamicQuery(
146                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
147                    int end,
148                    com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) {
149                    return getService()
150                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
151            }
152    
153            /**
154            * Returns the number of rows that match the dynamic query.
155            *
156            * @param dynamicQuery the dynamic query
157            * @return the number of rows that match the dynamic query
158            */
159            public static long dynamicQueryCount(
160                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) {
161                    return getService().dynamicQueryCount(dynamicQuery);
162            }
163    
164            /**
165            * Returns the number of rows that match the dynamic query.
166            *
167            * @param dynamicQuery the dynamic query
168            * @param projection the projection to apply to the query
169            * @return the number of rows that match the dynamic query
170            */
171            public static long dynamicQueryCount(
172                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
173                    com.liferay.portal.kernel.dao.orm.Projection projection) {
174                    return getService().dynamicQueryCount(dynamicQuery, projection);
175            }
176    
177            public static com.liferay.portlet.documentlibrary.model.DLFileVersion fetchDLFileVersion(
178                    long fileVersionId) {
179                    return getService().fetchDLFileVersion(fileVersionId);
180            }
181    
182            /**
183            * Returns the document library file version matching the UUID and group.
184            *
185            * @param uuid the document library file version's UUID
186            * @param groupId the primary key of the group
187            * @return the matching document library file version, or <code>null</code> if a matching document library file version could not be found
188            */
189            public static com.liferay.portlet.documentlibrary.model.DLFileVersion fetchDLFileVersionByUuidAndGroupId(
190                    java.lang.String uuid, long groupId) {
191                    return getService().fetchDLFileVersionByUuidAndGroupId(uuid, groupId);
192            }
193    
194            public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() {
195                    return getService().getActionableDynamicQuery();
196            }
197    
198            /**
199            * Returns the Spring bean ID for this bean.
200            *
201            * @return the Spring bean ID for this bean
202            */
203            public static java.lang.String getBeanIdentifier() {
204                    return getService().getBeanIdentifier();
205            }
206    
207            /**
208            * Returns the document library file version with the primary key.
209            *
210            * @param fileVersionId the primary key of the document library file version
211            * @return the document library file version
212            * @throws PortalException if a document library file version with the primary key could not be found
213            */
214            public static com.liferay.portlet.documentlibrary.model.DLFileVersion getDLFileVersion(
215                    long fileVersionId)
216                    throws com.liferay.portal.kernel.exception.PortalException {
217                    return getService().getDLFileVersion(fileVersionId);
218            }
219    
220            /**
221            * Returns the document library file version matching the UUID and group.
222            *
223            * @param uuid the document library file version's UUID
224            * @param groupId the primary key of the group
225            * @return the matching document library file version
226            * @throws PortalException if a matching document library file version could not be found
227            */
228            public static com.liferay.portlet.documentlibrary.model.DLFileVersion getDLFileVersionByUuidAndGroupId(
229                    java.lang.String uuid, long groupId)
230                    throws com.liferay.portal.kernel.exception.PortalException {
231                    return getService().getDLFileVersionByUuidAndGroupId(uuid, groupId);
232            }
233    
234            /**
235            * Returns a range of all the document library file versions.
236            *
237            * <p>
238            * 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.
239            * </p>
240            *
241            * @param start the lower bound of the range of document library file versions
242            * @param end the upper bound of the range of document library file versions (not inclusive)
243            * @return the range of document library file versions
244            */
245            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileVersion> getDLFileVersions(
246                    int start, int end) {
247                    return getService().getDLFileVersions(start, end);
248            }
249    
250            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileVersion> getDLFileVersionsByUuidAndCompanyId(
251                    java.lang.String uuid, long companyId) {
252                    return getService().getDLFileVersionsByUuidAndCompanyId(uuid, companyId);
253            }
254    
255            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileVersion> getDLFileVersionsByUuidAndCompanyId(
256                    java.lang.String uuid, long companyId, int start, int end,
257                    com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.documentlibrary.model.DLFileVersion> orderByComparator) {
258                    return getService()
259                                       .getDLFileVersionsByUuidAndCompanyId(uuid, companyId, start,
260                            end, orderByComparator);
261            }
262    
263            /**
264            * Returns the number of document library file versions.
265            *
266            * @return the number of document library file versions
267            */
268            public static int getDLFileVersionsCount() {
269                    return getService().getDLFileVersionsCount();
270            }
271    
272            public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(
273                    com.liferay.portal.kernel.lar.PortletDataContext portletDataContext) {
274                    return getService().getExportActionableDynamicQuery(portletDataContext);
275            }
276    
277            public static com.liferay.portlet.documentlibrary.model.DLFileVersion getFileVersion(
278                    long fileEntryId, java.lang.String version)
279                    throws com.liferay.portal.kernel.exception.PortalException {
280                    return getService().getFileVersion(fileEntryId, version);
281            }
282    
283            public static com.liferay.portlet.documentlibrary.model.DLFileVersion getFileVersion(
284                    long fileVersionId)
285                    throws com.liferay.portal.kernel.exception.PortalException {
286                    return getService().getFileVersion(fileVersionId);
287            }
288    
289            public static com.liferay.portlet.documentlibrary.model.DLFileVersion getFileVersionByUuidAndGroupId(
290                    java.lang.String uuid, long groupId) {
291                    return getService().getFileVersionByUuidAndGroupId(uuid, groupId);
292            }
293    
294            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileVersion> getFileVersions(
295                    long fileEntryId, int status) {
296                    return getService().getFileVersions(fileEntryId, status);
297            }
298    
299            public static int getFileVersionsCount(long fileEntryId, int status) {
300                    return getService().getFileVersionsCount(fileEntryId, status);
301            }
302    
303            public static com.liferay.portlet.documentlibrary.model.DLFileVersion getLatestFileVersion(
304                    long fileEntryId, boolean excludeWorkingCopy)
305                    throws com.liferay.portal.kernel.exception.PortalException {
306                    return getService().getLatestFileVersion(fileEntryId, excludeWorkingCopy);
307            }
308    
309            public static com.liferay.portlet.documentlibrary.model.DLFileVersion getLatestFileVersion(
310                    long userId, long fileEntryId)
311                    throws com.liferay.portal.kernel.exception.PortalException {
312                    return getService().getLatestFileVersion(userId, fileEntryId);
313            }
314    
315            public static com.liferay.portal.model.PersistedModel getPersistedModel(
316                    java.io.Serializable primaryKeyObj)
317                    throws com.liferay.portal.kernel.exception.PortalException {
318                    return getService().getPersistedModel(primaryKeyObj);
319            }
320    
321            public static void rebuildTree(long companyId)
322                    throws com.liferay.portal.kernel.exception.PortalException {
323                    getService().rebuildTree(companyId);
324            }
325    
326            /**
327            * Sets the Spring bean ID for this bean.
328            *
329            * @param beanIdentifier the Spring bean ID for this bean
330            */
331            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
332                    getService().setBeanIdentifier(beanIdentifier);
333            }
334    
335            public static void setTreePaths(long folderId, java.lang.String treePath)
336                    throws com.liferay.portal.kernel.exception.PortalException {
337                    getService().setTreePaths(folderId, treePath);
338            }
339    
340            /**
341            * Updates the document library file version in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
342            *
343            * @param dlFileVersion the document library file version
344            * @return the document library file version that was updated
345            */
346            public static com.liferay.portlet.documentlibrary.model.DLFileVersion updateDLFileVersion(
347                    com.liferay.portlet.documentlibrary.model.DLFileVersion dlFileVersion) {
348                    return getService().updateDLFileVersion(dlFileVersion);
349            }
350    
351            public static DLFileVersionLocalService getService() {
352                    if (_service == null) {
353                            _service = (DLFileVersionLocalService)PortalBeanLocatorUtil.locate(DLFileVersionLocalService.class.getName());
354    
355                            ReferenceRegistry.registerReference(DLFileVersionLocalServiceUtil.class,
356                                    "_service");
357                    }
358    
359                    return _service;
360            }
361    
362            /**
363             * @deprecated As of 6.2.0
364             */
365            @Deprecated
366            public void setService(DLFileVersionLocalService service) {
367            }
368    
369            private static DLFileVersionLocalService _service;
370    }