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     * Provides the local service utility for DLFileRank. This utility wraps
022     * {@link com.liferay.portlet.documentlibrary.service.impl.DLFileRankLocalServiceImpl} and is the
023     * primary access point for service operations in application layer code running
024     * on the local server. Methods of this service will not have security checks
025     * based on the propagated JAAS credentials because this service can only be
026     * accessed from within the same VM.
027     *
028     * @author Brian Wing Shun Chan
029     * @see DLFileRankLocalService
030     * @see com.liferay.portlet.documentlibrary.service.base.DLFileRankLocalServiceBaseImpl
031     * @see com.liferay.portlet.documentlibrary.service.impl.DLFileRankLocalServiceImpl
032     * @generated
033     */
034    public class DLFileRankLocalServiceUtil {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.documentlibrary.service.impl.DLFileRankLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
039             */
040    
041            /**
042            * Adds the document library file rank to the database. Also notifies the appropriate model listeners.
043            *
044            * @param dlFileRank the document library file rank
045            * @return the document library file rank that was added
046            * @throws SystemException if a system exception occurred
047            */
048            public static com.liferay.portlet.documentlibrary.model.DLFileRank addDLFileRank(
049                    com.liferay.portlet.documentlibrary.model.DLFileRank dlFileRank)
050                    throws com.liferay.portal.kernel.exception.SystemException {
051                    return getService().addDLFileRank(dlFileRank);
052            }
053    
054            /**
055            * Creates a new document library file rank with the primary key. Does not add the document library file rank to the database.
056            *
057            * @param fileRankId the primary key for the new document library file rank
058            * @return the new document library file rank
059            */
060            public static com.liferay.portlet.documentlibrary.model.DLFileRank createDLFileRank(
061                    long fileRankId) {
062                    return getService().createDLFileRank(fileRankId);
063            }
064    
065            /**
066            * Deletes the document library file rank with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param fileRankId the primary key of the document library file rank
069            * @return the document library file rank that was removed
070            * @throws PortalException if a document library file rank with the primary key could not be found
071            * @throws SystemException if a system exception occurred
072            */
073            public static com.liferay.portlet.documentlibrary.model.DLFileRank deleteDLFileRank(
074                    long fileRankId)
075                    throws com.liferay.portal.kernel.exception.PortalException,
076                            com.liferay.portal.kernel.exception.SystemException {
077                    return getService().deleteDLFileRank(fileRankId);
078            }
079    
080            /**
081            * Deletes the document library file rank from the database. Also notifies the appropriate model listeners.
082            *
083            * @param dlFileRank the document library file rank
084            * @return the document library file rank that was removed
085            * @throws SystemException if a system exception occurred
086            */
087            public static com.liferay.portlet.documentlibrary.model.DLFileRank deleteDLFileRank(
088                    com.liferay.portlet.documentlibrary.model.DLFileRank dlFileRank)
089                    throws com.liferay.portal.kernel.exception.SystemException {
090                    return getService().deleteDLFileRank(dlFileRank);
091            }
092    
093            public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
094                    return getService().dynamicQuery();
095            }
096    
097            /**
098            * Performs a dynamic query on the database and returns the matching rows.
099            *
100            * @param dynamicQuery the dynamic query
101            * @return the matching rows
102            * @throws SystemException if a system exception occurred
103            */
104            @SuppressWarnings("rawtypes")
105            public static java.util.List dynamicQuery(
106                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
107                    throws com.liferay.portal.kernel.exception.SystemException {
108                    return getService().dynamicQuery(dynamicQuery);
109            }
110    
111            /**
112            * Performs a dynamic query on the database and returns a range of the matching rows.
113            *
114            * <p>
115            * 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.DLFileRankModelImpl}. 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.
116            * </p>
117            *
118            * @param dynamicQuery the dynamic query
119            * @param start the lower bound of the range of model instances
120            * @param end the upper bound of the range of model instances (not inclusive)
121            * @return the range of matching rows
122            * @throws SystemException if a system exception occurred
123            */
124            @SuppressWarnings("rawtypes")
125            public static java.util.List dynamicQuery(
126                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
127                    int end) throws com.liferay.portal.kernel.exception.SystemException {
128                    return getService().dynamicQuery(dynamicQuery, start, end);
129            }
130    
131            /**
132            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
133            *
134            * <p>
135            * 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.DLFileRankModelImpl}. 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.
136            * </p>
137            *
138            * @param dynamicQuery the dynamic query
139            * @param start the lower bound of the range of model instances
140            * @param end the upper bound of the range of model instances (not inclusive)
141            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
142            * @return the ordered range of matching rows
143            * @throws SystemException if a system exception occurred
144            */
145            @SuppressWarnings("rawtypes")
146            public static java.util.List dynamicQuery(
147                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
148                    int end,
149                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
150                    throws com.liferay.portal.kernel.exception.SystemException {
151                    return getService()
152                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
153            }
154    
155            /**
156            * Returns the number of rows that match the dynamic query.
157            *
158            * @param dynamicQuery the dynamic query
159            * @return the number of rows that match the dynamic query
160            * @throws SystemException if a system exception occurred
161            */
162            public static long dynamicQueryCount(
163                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
164                    throws com.liferay.portal.kernel.exception.SystemException {
165                    return getService().dynamicQueryCount(dynamicQuery);
166            }
167    
168            /**
169            * Returns the number of rows that match the dynamic query.
170            *
171            * @param dynamicQuery the dynamic query
172            * @param projection the projection to apply to the query
173            * @return the number of rows that match the dynamic query
174            * @throws SystemException if a system exception occurred
175            */
176            public static long dynamicQueryCount(
177                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
178                    com.liferay.portal.kernel.dao.orm.Projection projection)
179                    throws com.liferay.portal.kernel.exception.SystemException {
180                    return getService().dynamicQueryCount(dynamicQuery, projection);
181            }
182    
183            public static com.liferay.portlet.documentlibrary.model.DLFileRank fetchDLFileRank(
184                    long fileRankId)
185                    throws com.liferay.portal.kernel.exception.SystemException {
186                    return getService().fetchDLFileRank(fileRankId);
187            }
188    
189            /**
190            * Returns the document library file rank with the primary key.
191            *
192            * @param fileRankId the primary key of the document library file rank
193            * @return the document library file rank
194            * @throws PortalException if a document library file rank with the primary key could not be found
195            * @throws SystemException if a system exception occurred
196            */
197            public static com.liferay.portlet.documentlibrary.model.DLFileRank getDLFileRank(
198                    long fileRankId)
199                    throws com.liferay.portal.kernel.exception.PortalException,
200                            com.liferay.portal.kernel.exception.SystemException {
201                    return getService().getDLFileRank(fileRankId);
202            }
203    
204            public static com.liferay.portal.model.PersistedModel getPersistedModel(
205                    java.io.Serializable primaryKeyObj)
206                    throws com.liferay.portal.kernel.exception.PortalException,
207                            com.liferay.portal.kernel.exception.SystemException {
208                    return getService().getPersistedModel(primaryKeyObj);
209            }
210    
211            /**
212            * Returns a range of all the document library file ranks.
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.DLFileRankModelImpl}. 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 ranks
219            * @param end the upper bound of the range of document library file ranks (not inclusive)
220            * @return the range of document library file ranks
221            * @throws SystemException if a system exception occurred
222            */
223            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileRank> getDLFileRanks(
224                    int start, int end)
225                    throws com.liferay.portal.kernel.exception.SystemException {
226                    return getService().getDLFileRanks(start, end);
227            }
228    
229            /**
230            * Returns the number of document library file ranks.
231            *
232            * @return the number of document library file ranks
233            * @throws SystemException if a system exception occurred
234            */
235            public static int getDLFileRanksCount()
236                    throws com.liferay.portal.kernel.exception.SystemException {
237                    return getService().getDLFileRanksCount();
238            }
239    
240            /**
241            * Updates the document library file rank in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
242            *
243            * @param dlFileRank the document library file rank
244            * @return the document library file rank that was updated
245            * @throws SystemException if a system exception occurred
246            */
247            public static com.liferay.portlet.documentlibrary.model.DLFileRank updateDLFileRank(
248                    com.liferay.portlet.documentlibrary.model.DLFileRank dlFileRank)
249                    throws com.liferay.portal.kernel.exception.SystemException {
250                    return getService().updateDLFileRank(dlFileRank);
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.DLFileRank addFileRank(
272                    long groupId, long companyId, long userId, long fileEntryId,
273                    com.liferay.portal.service.ServiceContext serviceContext)
274                    throws com.liferay.portal.kernel.exception.SystemException {
275                    return getService()
276                                       .addFileRank(groupId, companyId, userId, fileEntryId,
277                            serviceContext);
278            }
279    
280            public static void checkFileRanks()
281                    throws com.liferay.portal.kernel.exception.SystemException {
282                    getService().checkFileRanks();
283            }
284    
285            public static void deleteFileRank(
286                    com.liferay.portlet.documentlibrary.model.DLFileRank dlFileRank)
287                    throws com.liferay.portal.kernel.exception.SystemException {
288                    getService().deleteFileRank(dlFileRank);
289            }
290    
291            public static void deleteFileRank(long fileRankId)
292                    throws com.liferay.portal.kernel.exception.PortalException,
293                            com.liferay.portal.kernel.exception.SystemException {
294                    getService().deleteFileRank(fileRankId);
295            }
296    
297            public static void deleteFileRanksByFileEntryId(long fileEntryId)
298                    throws com.liferay.portal.kernel.exception.SystemException {
299                    getService().deleteFileRanksByFileEntryId(fileEntryId);
300            }
301    
302            public static void deleteFileRanksByUserId(long userId)
303                    throws com.liferay.portal.kernel.exception.SystemException {
304                    getService().deleteFileRanksByUserId(userId);
305            }
306    
307            public static void disableFileRanks(long fileEntryId)
308                    throws com.liferay.portal.kernel.exception.SystemException {
309                    getService().disableFileRanks(fileEntryId);
310            }
311    
312            public static void disableFileRanksByFolderId(long folderId)
313                    throws com.liferay.portal.kernel.exception.PortalException,
314                            com.liferay.portal.kernel.exception.SystemException {
315                    getService().disableFileRanksByFolderId(folderId);
316            }
317    
318            public static void enableFileRanks(long fileEntryId)
319                    throws com.liferay.portal.kernel.exception.SystemException {
320                    getService().enableFileRanks(fileEntryId);
321            }
322    
323            public static void enableFileRanksByFolderId(long folderId)
324                    throws com.liferay.portal.kernel.exception.PortalException,
325                            com.liferay.portal.kernel.exception.SystemException {
326                    getService().enableFileRanksByFolderId(folderId);
327            }
328    
329            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileRank> getFileRanks(
330                    long groupId, long userId)
331                    throws com.liferay.portal.kernel.exception.SystemException {
332                    return getService().getFileRanks(groupId, userId);
333            }
334    
335            public static com.liferay.portlet.documentlibrary.model.DLFileRank updateFileRank(
336                    long groupId, long companyId, long userId, long fileEntryId,
337                    com.liferay.portal.service.ServiceContext serviceContext)
338                    throws com.liferay.portal.kernel.exception.SystemException {
339                    return getService()
340                                       .updateFileRank(groupId, companyId, userId, fileEntryId,
341                            serviceContext);
342            }
343    
344            public static DLFileRankLocalService getService() {
345                    if (_service == null) {
346                            _service = (DLFileRankLocalService)PortalBeanLocatorUtil.locate(DLFileRankLocalService.class.getName());
347    
348                            ReferenceRegistry.registerReference(DLFileRankLocalServiceUtil.class,
349                                    "_service");
350                    }
351    
352                    return _service;
353            }
354    
355            /**
356             * @deprecated As of 6.2.0
357             */
358            public void setService(DLFileRankLocalService service) {
359            }
360    
361            private static DLFileRankLocalService _service;
362    }