001    /**
002     * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
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.MethodCache;
019    import com.liferay.portal.kernel.util.ReferenceRegistry;
020    
021    /**
022     * 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.
023     *
024     * <p>
025     * 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.
026     * </p>
027     *
028     * @author Brian Wing Shun Chan
029     * @see DLFileVersionLocalService
030     * @see com.liferay.portlet.documentlibrary.service.base.DLFileVersionLocalServiceBaseImpl
031     * @see com.liferay.portlet.documentlibrary.service.impl.DLFileVersionLocalServiceImpl
032     * @generated
033     */
034    public class DLFileVersionLocalServiceUtil {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * 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.
039             */
040    
041            /**
042            * Adds the document library file version to the database. Also notifies the appropriate model listeners.
043            *
044            * @param dlFileVersion the document library file version
045            * @return the document library file version that was added
046            * @throws SystemException if a system exception occurred
047            */
048            public static com.liferay.portlet.documentlibrary.model.DLFileVersion addDLFileVersion(
049                    com.liferay.portlet.documentlibrary.model.DLFileVersion dlFileVersion)
050                    throws com.liferay.portal.kernel.exception.SystemException {
051                    return getService().addDLFileVersion(dlFileVersion);
052            }
053    
054            /**
055            * Creates a new document library file version with the primary key. Does not add the document library file version to the database.
056            *
057            * @param fileVersionId the primary key for the new document library file version
058            * @return the new document library file version
059            */
060            public static com.liferay.portlet.documentlibrary.model.DLFileVersion createDLFileVersion(
061                    long fileVersionId) {
062                    return getService().createDLFileVersion(fileVersionId);
063            }
064    
065            /**
066            * Deletes the document library file version with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param fileVersionId the primary key of the document library file version
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 void deleteDLFileVersion(long fileVersionId)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException {
075                    getService().deleteDLFileVersion(fileVersionId);
076            }
077    
078            /**
079            * Deletes the document library file version from the database. Also notifies the appropriate model listeners.
080            *
081            * @param dlFileVersion the document library file version
082            * @throws SystemException if a system exception occurred
083            */
084            public static void deleteDLFileVersion(
085                    com.liferay.portlet.documentlibrary.model.DLFileVersion dlFileVersion)
086                    throws com.liferay.portal.kernel.exception.SystemException {
087                    getService().deleteDLFileVersion(dlFileVersion);
088            }
089    
090            /**
091            * Performs a dynamic query on the database and returns the matching rows.
092            *
093            * @param dynamicQuery the dynamic query
094            * @return the matching rows
095            * @throws SystemException if a system exception occurred
096            */
097            @SuppressWarnings("rawtypes")
098            public static java.util.List dynamicQuery(
099                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
100                    throws com.liferay.portal.kernel.exception.SystemException {
101                    return getService().dynamicQuery(dynamicQuery);
102            }
103    
104            /**
105            * Performs a dynamic query on the database and returns a range of the matching rows.
106            *
107            * <p>
108            * 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.
109            * </p>
110            *
111            * @param dynamicQuery the dynamic query
112            * @param start the lower bound of the range of model instances
113            * @param end the upper bound of the range of model instances (not inclusive)
114            * @return the range of matching rows
115            * @throws SystemException if a system exception occurred
116            */
117            @SuppressWarnings("rawtypes")
118            public static java.util.List dynamicQuery(
119                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
120                    int end) throws com.liferay.portal.kernel.exception.SystemException {
121                    return getService().dynamicQuery(dynamicQuery, start, end);
122            }
123    
124            /**
125            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
126            *
127            * <p>
128            * 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.
129            * </p>
130            *
131            * @param dynamicQuery the dynamic query
132            * @param start the lower bound of the range of model instances
133            * @param end the upper bound of the range of model instances (not inclusive)
134            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
135            * @return the ordered range of matching rows
136            * @throws SystemException if a system exception occurred
137            */
138            @SuppressWarnings("rawtypes")
139            public static java.util.List dynamicQuery(
140                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
141                    int end,
142                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
143                    throws com.liferay.portal.kernel.exception.SystemException {
144                    return getService()
145                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
146            }
147    
148            /**
149            * Returns the number of rows that match the dynamic query.
150            *
151            * @param dynamicQuery the dynamic query
152            * @return the number of rows that match the dynamic query
153            * @throws SystemException if a system exception occurred
154            */
155            public static long dynamicQueryCount(
156                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
157                    throws com.liferay.portal.kernel.exception.SystemException {
158                    return getService().dynamicQueryCount(dynamicQuery);
159            }
160    
161            public static com.liferay.portlet.documentlibrary.model.DLFileVersion fetchDLFileVersion(
162                    long fileVersionId)
163                    throws com.liferay.portal.kernel.exception.SystemException {
164                    return getService().fetchDLFileVersion(fileVersionId);
165            }
166    
167            /**
168            * Returns the document library file version with the primary key.
169            *
170            * @param fileVersionId the primary key of the document library file version
171            * @return the document library file version
172            * @throws PortalException if a document library file version with the primary key could not be found
173            * @throws SystemException if a system exception occurred
174            */
175            public static com.liferay.portlet.documentlibrary.model.DLFileVersion getDLFileVersion(
176                    long fileVersionId)
177                    throws com.liferay.portal.kernel.exception.PortalException,
178                            com.liferay.portal.kernel.exception.SystemException {
179                    return getService().getDLFileVersion(fileVersionId);
180            }
181    
182            public static com.liferay.portal.model.PersistedModel getPersistedModel(
183                    java.io.Serializable primaryKeyObj)
184                    throws com.liferay.portal.kernel.exception.PortalException,
185                            com.liferay.portal.kernel.exception.SystemException {
186                    return getService().getPersistedModel(primaryKeyObj);
187            }
188    
189            /**
190            * Returns a range of all the document library file versions.
191            *
192            * <p>
193            * 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.
194            * </p>
195            *
196            * @param start the lower bound of the range of document library file versions
197            * @param end the upper bound of the range of document library file versions (not inclusive)
198            * @return the range of document library file versions
199            * @throws SystemException if a system exception occurred
200            */
201            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileVersion> getDLFileVersions(
202                    int start, int end)
203                    throws com.liferay.portal.kernel.exception.SystemException {
204                    return getService().getDLFileVersions(start, end);
205            }
206    
207            /**
208            * Returns the number of document library file versions.
209            *
210            * @return the number of document library file versions
211            * @throws SystemException if a system exception occurred
212            */
213            public static int getDLFileVersionsCount()
214                    throws com.liferay.portal.kernel.exception.SystemException {
215                    return getService().getDLFileVersionsCount();
216            }
217    
218            /**
219            * Updates the document library file version in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
220            *
221            * @param dlFileVersion the document library file version
222            * @return the document library file version that was updated
223            * @throws SystemException if a system exception occurred
224            */
225            public static com.liferay.portlet.documentlibrary.model.DLFileVersion updateDLFileVersion(
226                    com.liferay.portlet.documentlibrary.model.DLFileVersion dlFileVersion)
227                    throws com.liferay.portal.kernel.exception.SystemException {
228                    return getService().updateDLFileVersion(dlFileVersion);
229            }
230    
231            /**
232            * Updates the document library file version in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
233            *
234            * @param dlFileVersion the document library file version
235            * @param merge whether to merge the document library file version with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation.
236            * @return the document library file version that was updated
237            * @throws SystemException if a system exception occurred
238            */
239            public static com.liferay.portlet.documentlibrary.model.DLFileVersion updateDLFileVersion(
240                    com.liferay.portlet.documentlibrary.model.DLFileVersion dlFileVersion,
241                    boolean merge)
242                    throws com.liferay.portal.kernel.exception.SystemException {
243                    return getService().updateDLFileVersion(dlFileVersion, merge);
244            }
245    
246            /**
247            * Returns the Spring bean ID for this bean.
248            *
249            * @return the Spring bean ID for this bean
250            */
251            public static java.lang.String getBeanIdentifier() {
252                    return getService().getBeanIdentifier();
253            }
254    
255            /**
256            * Sets the Spring bean ID for this bean.
257            *
258            * @param beanIdentifier the Spring bean ID for this bean
259            */
260            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
261                    getService().setBeanIdentifier(beanIdentifier);
262            }
263    
264            public static com.liferay.portlet.documentlibrary.model.DLFileVersion getFileVersion(
265                    long fileVersionId)
266                    throws com.liferay.portal.kernel.exception.PortalException,
267                            com.liferay.portal.kernel.exception.SystemException {
268                    return getService().getFileVersion(fileVersionId);
269            }
270    
271            public static com.liferay.portlet.documentlibrary.model.DLFileVersion getFileVersion(
272                    long fileEntryId, java.lang.String version)
273                    throws com.liferay.portal.kernel.exception.PortalException,
274                            com.liferay.portal.kernel.exception.SystemException {
275                    return getService().getFileVersion(fileEntryId, version);
276            }
277    
278            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileVersion> getFileVersions(
279                    long fileEntryId, int status)
280                    throws com.liferay.portal.kernel.exception.SystemException {
281                    return getService().getFileVersions(fileEntryId, status);
282            }
283    
284            public static com.liferay.portlet.documentlibrary.model.DLFileVersion getLatestFileVersion(
285                    long fileEntryId, boolean excludeWorkingCopy)
286                    throws com.liferay.portal.kernel.exception.PortalException,
287                            com.liferay.portal.kernel.exception.SystemException {
288                    return getService().getLatestFileVersion(fileEntryId, excludeWorkingCopy);
289            }
290    
291            public static com.liferay.portlet.documentlibrary.model.DLFileVersion getLatestFileVersion(
292                    long userId, long fileEntryId)
293                    throws com.liferay.portal.kernel.exception.PortalException,
294                            com.liferay.portal.kernel.exception.SystemException {
295                    return getService().getLatestFileVersion(userId, fileEntryId);
296            }
297    
298            public static DLFileVersionLocalService getService() {
299                    if (_service == null) {
300                            _service = (DLFileVersionLocalService)PortalBeanLocatorUtil.locate(DLFileVersionLocalService.class.getName());
301    
302                            ReferenceRegistry.registerReference(DLFileVersionLocalServiceUtil.class,
303                                    "_service");
304                            MethodCache.remove(DLFileVersionLocalService.class);
305                    }
306    
307                    return _service;
308            }
309    
310            public void setService(DLFileVersionLocalService service) {
311                    MethodCache.remove(DLFileVersionLocalService.class);
312    
313                    _service = service;
314    
315                    ReferenceRegistry.registerReference(DLFileVersionLocalServiceUtil.class,
316                            "_service");
317                    MethodCache.remove(DLFileVersionLocalService.class);
318            }
319    
320            private static DLFileVersionLocalService _service;
321    }