001    /**
002     * Copyright (c) 2000-2012 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 rank local service. This utility wraps {@link com.liferay.portlet.documentlibrary.service.impl.DLFileRankLocalServiceImpl} 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 DLFileRankLocalService
029     * @see com.liferay.portlet.documentlibrary.service.base.DLFileRankLocalServiceBaseImpl
030     * @see com.liferay.portlet.documentlibrary.service.impl.DLFileRankLocalServiceImpl
031     * @generated
032     */
033    public class DLFileRankLocalServiceUtil {
034            /*
035             * NOTE FOR DEVELOPERS:
036             *
037             * 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.
038             */
039    
040            /**
041            * Adds the document library file rank to the database. Also notifies the appropriate model listeners.
042            *
043            * @param dlFileRank the document library file rank
044            * @return the document library file rank that was added
045            * @throws SystemException if a system exception occurred
046            */
047            public static com.liferay.portlet.documentlibrary.model.DLFileRank addDLFileRank(
048                    com.liferay.portlet.documentlibrary.model.DLFileRank dlFileRank)
049                    throws com.liferay.portal.kernel.exception.SystemException {
050                    return getService().addDLFileRank(dlFileRank);
051            }
052    
053            /**
054            * Creates a new document library file rank with the primary key. Does not add the document library file rank to the database.
055            *
056            * @param fileRankId the primary key for the new document library file rank
057            * @return the new document library file rank
058            */
059            public static com.liferay.portlet.documentlibrary.model.DLFileRank createDLFileRank(
060                    long fileRankId) {
061                    return getService().createDLFileRank(fileRankId);
062            }
063    
064            /**
065            * Deletes the document library file rank with the primary key from the database. Also notifies the appropriate model listeners.
066            *
067            * @param fileRankId the primary key of the document library file rank
068            * @return the document library file rank that was removed
069            * @throws PortalException if a document library file rank 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.DLFileRank deleteDLFileRank(
073                    long fileRankId)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException {
076                    return getService().deleteDLFileRank(fileRankId);
077            }
078    
079            /**
080            * Deletes the document library file rank from the database. Also notifies the appropriate model listeners.
081            *
082            * @param dlFileRank the document library file rank
083            * @return the document library file rank that was removed
084            * @throws SystemException if a system exception occurred
085            */
086            public static com.liferay.portlet.documentlibrary.model.DLFileRank deleteDLFileRank(
087                    com.liferay.portlet.documentlibrary.model.DLFileRank dlFileRank)
088                    throws com.liferay.portal.kernel.exception.SystemException {
089                    return getService().deleteDLFileRank(dlFileRank);
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.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.
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.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.
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.DLFileRank fetchDLFileRank(
168                    long fileRankId)
169                    throws com.liferay.portal.kernel.exception.SystemException {
170                    return getService().fetchDLFileRank(fileRankId);
171            }
172    
173            /**
174            * Returns the document library file rank with the primary key.
175            *
176            * @param fileRankId the primary key of the document library file rank
177            * @return the document library file rank
178            * @throws PortalException if a document library file rank 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.DLFileRank getDLFileRank(
182                    long fileRankId)
183                    throws com.liferay.portal.kernel.exception.PortalException,
184                            com.liferay.portal.kernel.exception.SystemException {
185                    return getService().getDLFileRank(fileRankId);
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 a range of all the document library file ranks.
197            *
198            * <p>
199            * 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.
200            * </p>
201            *
202            * @param start the lower bound of the range of document library file ranks
203            * @param end the upper bound of the range of document library file ranks (not inclusive)
204            * @return the range of document library file ranks
205            * @throws SystemException if a system exception occurred
206            */
207            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileRank> getDLFileRanks(
208                    int start, int end)
209                    throws com.liferay.portal.kernel.exception.SystemException {
210                    return getService().getDLFileRanks(start, end);
211            }
212    
213            /**
214            * Returns the number of document library file ranks.
215            *
216            * @return the number of document library file ranks
217            * @throws SystemException if a system exception occurred
218            */
219            public static int getDLFileRanksCount()
220                    throws com.liferay.portal.kernel.exception.SystemException {
221                    return getService().getDLFileRanksCount();
222            }
223    
224            /**
225            * Updates the document library file rank in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
226            *
227            * @param dlFileRank the document library file rank
228            * @return the document library file rank that was updated
229            * @throws SystemException if a system exception occurred
230            */
231            public static com.liferay.portlet.documentlibrary.model.DLFileRank updateDLFileRank(
232                    com.liferay.portlet.documentlibrary.model.DLFileRank dlFileRank)
233                    throws com.liferay.portal.kernel.exception.SystemException {
234                    return getService().updateDLFileRank(dlFileRank);
235            }
236    
237            /**
238            * Returns the Spring bean ID for this bean.
239            *
240            * @return the Spring bean ID for this bean
241            */
242            public static java.lang.String getBeanIdentifier() {
243                    return getService().getBeanIdentifier();
244            }
245    
246            /**
247            * Sets the Spring bean ID for this bean.
248            *
249            * @param beanIdentifier the Spring bean ID for this bean
250            */
251            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
252                    getService().setBeanIdentifier(beanIdentifier);
253            }
254    
255            public static com.liferay.portlet.documentlibrary.model.DLFileRank addFileRank(
256                    long groupId, long companyId, long userId, long fileEntryId,
257                    com.liferay.portal.service.ServiceContext serviceContext)
258                    throws com.liferay.portal.kernel.exception.SystemException {
259                    return getService()
260                                       .addFileRank(groupId, companyId, userId, fileEntryId,
261                            serviceContext);
262            }
263    
264            public static void checkFileRanks()
265                    throws com.liferay.portal.kernel.exception.SystemException {
266                    getService().checkFileRanks();
267            }
268    
269            public static void deleteFileRank(
270                    com.liferay.portlet.documentlibrary.model.DLFileRank dlFileRank)
271                    throws com.liferay.portal.kernel.exception.SystemException {
272                    getService().deleteFileRank(dlFileRank);
273            }
274    
275            public static void deleteFileRank(long fileRankId)
276                    throws com.liferay.portal.kernel.exception.PortalException,
277                            com.liferay.portal.kernel.exception.SystemException {
278                    getService().deleteFileRank(fileRankId);
279            }
280    
281            public static void deleteFileRanksByFileEntryId(long fileEntryId)
282                    throws com.liferay.portal.kernel.exception.SystemException {
283                    getService().deleteFileRanksByFileEntryId(fileEntryId);
284            }
285    
286            public static void deleteFileRanksByUserId(long userId)
287                    throws com.liferay.portal.kernel.exception.SystemException {
288                    getService().deleteFileRanksByUserId(userId);
289            }
290    
291            public static void disableFileRanks(long fileEntryId)
292                    throws com.liferay.portal.kernel.exception.SystemException {
293                    getService().disableFileRanks(fileEntryId);
294            }
295    
296            public static void disableFileRanksByFolderId(long folderId)
297                    throws com.liferay.portal.kernel.exception.PortalException,
298                            com.liferay.portal.kernel.exception.SystemException {
299                    getService().disableFileRanksByFolderId(folderId);
300            }
301    
302            public static void enableFileRanks(long fileEntryId)
303                    throws com.liferay.portal.kernel.exception.SystemException {
304                    getService().enableFileRanks(fileEntryId);
305            }
306    
307            public static void enableFileRanksByFolderId(long folderId)
308                    throws com.liferay.portal.kernel.exception.PortalException,
309                            com.liferay.portal.kernel.exception.SystemException {
310                    getService().enableFileRanksByFolderId(folderId);
311            }
312    
313            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileRank> getFileRanks(
314                    long groupId, long userId)
315                    throws com.liferay.portal.kernel.exception.SystemException {
316                    return getService().getFileRanks(groupId, userId);
317            }
318    
319            public static com.liferay.portlet.documentlibrary.model.DLFileRank updateFileRank(
320                    long groupId, long companyId, long userId, long fileEntryId,
321                    com.liferay.portal.service.ServiceContext serviceContext)
322                    throws com.liferay.portal.kernel.exception.SystemException {
323                    return getService()
324                                       .updateFileRank(groupId, companyId, userId, fileEntryId,
325                            serviceContext);
326            }
327    
328            public static DLFileRankLocalService getService() {
329                    if (_service == null) {
330                            _service = (DLFileRankLocalService)PortalBeanLocatorUtil.locate(DLFileRankLocalService.class.getName());
331    
332                            ReferenceRegistry.registerReference(DLFileRankLocalServiceUtil.class,
333                                    "_service");
334                    }
335    
336                    return _service;
337            }
338    
339            /**
340             * @deprecated
341             */
342            public void setService(DLFileRankLocalService service) {
343            }
344    
345            private static DLFileRankLocalService _service;
346    }