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 com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
018    import com.liferay.portal.kernel.util.ReferenceRegistry;
019    
020    /**
021     * The utility for the document library file version local service. This utility wraps {@link com.liferay.portlet.documentlibrary.service.impl.DLFileVersionLocalServiceImpl} and is the primary access point for service operations in application layer code running on the local server.
022     *
023     * <p>
024     * This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
025     * </p>
026     *
027     * @author Brian Wing Shun Chan
028     * @see DLFileVersionLocalService
029     * @see com.liferay.portlet.documentlibrary.service.base.DLFileVersionLocalServiceBaseImpl
030     * @see com.liferay.portlet.documentlibrary.service.impl.DLFileVersionLocalServiceImpl
031     * @generated
032     */
033    public class DLFileVersionLocalServiceUtil {
034            /*
035             * NOTE FOR DEVELOPERS:
036             *
037             * 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.
038             */
039    
040            /**
041            * Adds the document library file version to the database. Also notifies the appropriate model listeners.
042            *
043            * @param dlFileVersion the document library file version
044            * @return the document library file version that was added
045            * @throws SystemException if a system exception occurred
046            */
047            public static com.liferay.portlet.documentlibrary.model.DLFileVersion addDLFileVersion(
048                    com.liferay.portlet.documentlibrary.model.DLFileVersion dlFileVersion)
049                    throws com.liferay.portal.kernel.exception.SystemException {
050                    return getService().addDLFileVersion(dlFileVersion);
051            }
052    
053            /**
054            * Creates a new document library file version with the primary key. Does not add the document library file version to the database.
055            *
056            * @param fileVersionId the primary key for the new document library file version
057            * @return the new document library file version
058            */
059            public static com.liferay.portlet.documentlibrary.model.DLFileVersion createDLFileVersion(
060                    long fileVersionId) {
061                    return getService().createDLFileVersion(fileVersionId);
062            }
063    
064            /**
065            * Deletes the document library file version with the primary key from the database. Also notifies the appropriate model listeners.
066            *
067            * @param fileVersionId the primary key of the document library file version
068            * @return the document library file version that was removed
069            * @throws PortalException if a document library file version with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static com.liferay.portlet.documentlibrary.model.DLFileVersion deleteDLFileVersion(
073                    long fileVersionId)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException {
076                    return getService().deleteDLFileVersion(fileVersionId);
077            }
078    
079            /**
080            * Deletes the document library file version from the database. Also notifies the appropriate model listeners.
081            *
082            * @param dlFileVersion the document library file version
083            * @return the document library file version that was removed
084            * @throws SystemException if a system exception occurred
085            */
086            public static com.liferay.portlet.documentlibrary.model.DLFileVersion deleteDLFileVersion(
087                    com.liferay.portlet.documentlibrary.model.DLFileVersion dlFileVersion)
088                    throws com.liferay.portal.kernel.exception.SystemException {
089                    return getService().deleteDLFileVersion(dlFileVersion);
090            }
091    
092            public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
093                    return getService().dynamicQuery();
094            }
095    
096            /**
097            * Performs a dynamic query on the database and returns the matching rows.
098            *
099            * @param dynamicQuery the dynamic query
100            * @return the matching rows
101            * @throws SystemException if a system exception occurred
102            */
103            @SuppressWarnings("rawtypes")
104            public static java.util.List dynamicQuery(
105                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
106                    throws com.liferay.portal.kernel.exception.SystemException {
107                    return getService().dynamicQuery(dynamicQuery);
108            }
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            * @throws SystemException if a system exception occurred
122            */
123            @SuppressWarnings("rawtypes")
124            public static java.util.List dynamicQuery(
125                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
126                    int end) throws com.liferay.portal.kernel.exception.SystemException {
127                    return getService().dynamicQuery(dynamicQuery, start, end);
128            }
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 static 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                    return getService()
151                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
152            }
153    
154            /**
155            * Returns the number of rows that match the dynamic query.
156            *
157            * @param dynamicQuery the dynamic query
158            * @return the number of rows that match the dynamic query
159            * @throws SystemException if a system exception occurred
160            */
161            public static long dynamicQueryCount(
162                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
163                    throws com.liferay.portal.kernel.exception.SystemException {
164                    return getService().dynamicQueryCount(dynamicQuery);
165            }
166    
167            public static com.liferay.portlet.documentlibrary.model.DLFileVersion fetchDLFileVersion(
168                    long fileVersionId)
169                    throws com.liferay.portal.kernel.exception.SystemException {
170                    return getService().fetchDLFileVersion(fileVersionId);
171            }
172    
173            /**
174            * Returns the document library file version with the primary key.
175            *
176            * @param fileVersionId the primary key of the document library file version
177            * @return the document library file version
178            * @throws PortalException if a document library file version with the primary key could not be found
179            * @throws SystemException if a system exception occurred
180            */
181            public static com.liferay.portlet.documentlibrary.model.DLFileVersion getDLFileVersion(
182                    long fileVersionId)
183                    throws com.liferay.portal.kernel.exception.PortalException,
184                            com.liferay.portal.kernel.exception.SystemException {
185                    return getService().getDLFileVersion(fileVersionId);
186            }
187    
188            public static com.liferay.portal.model.PersistedModel getPersistedModel(
189                    java.io.Serializable primaryKeyObj)
190                    throws com.liferay.portal.kernel.exception.PortalException,
191                            com.liferay.portal.kernel.exception.SystemException {
192                    return getService().getPersistedModel(primaryKeyObj);
193            }
194    
195            /**
196            * Returns the document library file version matching the UUID and group.
197            *
198            * @param uuid the document library file version's UUID
199            * @param groupId the primary key of the group
200            * @return the matching document library file version
201            * @throws PortalException if a matching document library file version could not be found
202            * @throws SystemException if a system exception occurred
203            */
204            public static com.liferay.portlet.documentlibrary.model.DLFileVersion getDLFileVersionByUuidAndGroupId(
205                    java.lang.String uuid, long groupId)
206                    throws com.liferay.portal.kernel.exception.PortalException,
207                            com.liferay.portal.kernel.exception.SystemException {
208                    return getService().getDLFileVersionByUuidAndGroupId(uuid, groupId);
209            }
210    
211            /**
212            * Returns a range of all the document library file versions.
213            *
214            * <p>
215            * 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.
216            * </p>
217            *
218            * @param start the lower bound of the range of document library file versions
219            * @param end the upper bound of the range of document library file versions (not inclusive)
220            * @return the range of document library file versions
221            * @throws SystemException if a system exception occurred
222            */
223            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileVersion> getDLFileVersions(
224                    int start, int end)
225                    throws com.liferay.portal.kernel.exception.SystemException {
226                    return getService().getDLFileVersions(start, end);
227            }
228    
229            /**
230            * Returns the number of document library file versions.
231            *
232            * @return the number of document library file versions
233            * @throws SystemException if a system exception occurred
234            */
235            public static int getDLFileVersionsCount()
236                    throws com.liferay.portal.kernel.exception.SystemException {
237                    return getService().getDLFileVersionsCount();
238            }
239    
240            /**
241            * Updates the document library file version in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
242            *
243            * @param dlFileVersion the document library file version
244            * @return the document library file version that was updated
245            * @throws SystemException if a system exception occurred
246            */
247            public static com.liferay.portlet.documentlibrary.model.DLFileVersion updateDLFileVersion(
248                    com.liferay.portlet.documentlibrary.model.DLFileVersion dlFileVersion)
249                    throws com.liferay.portal.kernel.exception.SystemException {
250                    return getService().updateDLFileVersion(dlFileVersion);
251            }
252    
253            /**
254            * Returns the Spring bean ID for this bean.
255            *
256            * @return the Spring bean ID for this bean
257            */
258            public static java.lang.String getBeanIdentifier() {
259                    return getService().getBeanIdentifier();
260            }
261    
262            /**
263            * Sets the Spring bean ID for this bean.
264            *
265            * @param beanIdentifier the Spring bean ID for this bean
266            */
267            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
268                    getService().setBeanIdentifier(beanIdentifier);
269            }
270    
271            public static com.liferay.portlet.documentlibrary.model.DLFileVersion getFileVersion(
272                    long fileVersionId)
273                    throws com.liferay.portal.kernel.exception.PortalException,
274                            com.liferay.portal.kernel.exception.SystemException {
275                    return getService().getFileVersion(fileVersionId);
276            }
277    
278            public static com.liferay.portlet.documentlibrary.model.DLFileVersion getFileVersion(
279                    long fileEntryId, java.lang.String version)
280                    throws com.liferay.portal.kernel.exception.PortalException,
281                            com.liferay.portal.kernel.exception.SystemException {
282                    return getService().getFileVersion(fileEntryId, version);
283            }
284    
285            public static com.liferay.portlet.documentlibrary.model.DLFileVersion getFileVersionByUuidAndGroupId(
286                    java.lang.String uuid, long groupId)
287                    throws com.liferay.portal.kernel.exception.SystemException {
288                    return getService().getFileVersionByUuidAndGroupId(uuid, groupId);
289            }
290    
291            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileVersion> getFileVersions(
292                    long fileEntryId, int status)
293                    throws com.liferay.portal.kernel.exception.SystemException {
294                    return getService().getFileVersions(fileEntryId, status);
295            }
296    
297            public static int getFileVersionsCount(long fileEntryId, int status)
298                    throws com.liferay.portal.kernel.exception.SystemException {
299                    return getService().getFileVersionsCount(fileEntryId, status);
300            }
301    
302            public static com.liferay.portlet.documentlibrary.model.DLFileVersion getLatestFileVersion(
303                    long fileEntryId, boolean excludeWorkingCopy)
304                    throws com.liferay.portal.kernel.exception.PortalException,
305                            com.liferay.portal.kernel.exception.SystemException {
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                            com.liferay.portal.kernel.exception.SystemException {
313                    return getService().getLatestFileVersion(userId, fileEntryId);
314            }
315    
316            public static DLFileVersionLocalService getService() {
317                    if (_service == null) {
318                            _service = (DLFileVersionLocalService)PortalBeanLocatorUtil.locate(DLFileVersionLocalService.class.getName());
319    
320                            ReferenceRegistry.registerReference(DLFileVersionLocalServiceUtil.class,
321                                    "_service");
322                    }
323    
324                    return _service;
325            }
326    
327            /**
328             * @deprecated As of 6.2.0
329             */
330            public void setService(DLFileVersionLocalService service) {
331            }
332    
333            private static DLFileVersionLocalService _service;
334    }