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 d l 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.
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 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 d l file rank to the database. Also notifies the appropriate model listeners.
043            *
044            * @param dlFileRank the d l file rank
045            * @return the d l 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 d l file rank with the primary key. Does not add the d l file rank to the database.
056            *
057            * @param fileRankId the primary key for the new d l file rank
058            * @return the new d l 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 d l file rank with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param fileRankId the primary key of the d l file rank
069            * @throws PortalException if a d l file rank with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static void deleteDLFileRank(long fileRankId)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException {
075                    getService().deleteDLFileRank(fileRankId);
076            }
077    
078            /**
079            * Deletes the d l file rank from the database. Also notifies the appropriate model listeners.
080            *
081            * @param dlFileRank the d l file rank
082            * @throws SystemException if a system exception occurred
083            */
084            public static void deleteDLFileRank(
085                    com.liferay.portlet.documentlibrary.model.DLFileRank dlFileRank)
086                    throws com.liferay.portal.kernel.exception.SystemException {
087                    getService().deleteDLFileRank(dlFileRank);
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            /**
162            * Returns the d l file rank with the primary key.
163            *
164            * @param fileRankId the primary key of the d l file rank
165            * @return the d l file rank
166            * @throws PortalException if a d l file rank with the primary key could not be found
167            * @throws SystemException if a system exception occurred
168            */
169            public static com.liferay.portlet.documentlibrary.model.DLFileRank getDLFileRank(
170                    long fileRankId)
171                    throws com.liferay.portal.kernel.exception.PortalException,
172                            com.liferay.portal.kernel.exception.SystemException {
173                    return getService().getDLFileRank(fileRankId);
174            }
175    
176            public static com.liferay.portal.model.PersistedModel getPersistedModel(
177                    java.io.Serializable primaryKeyObj)
178                    throws com.liferay.portal.kernel.exception.PortalException,
179                            com.liferay.portal.kernel.exception.SystemException {
180                    return getService().getPersistedModel(primaryKeyObj);
181            }
182    
183            /**
184            * Returns a range of all the d l file ranks.
185            *
186            * <p>
187            * 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.
188            * </p>
189            *
190            * @param start the lower bound of the range of d l file ranks
191            * @param end the upper bound of the range of d l file ranks (not inclusive)
192            * @return the range of d l file ranks
193            * @throws SystemException if a system exception occurred
194            */
195            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileRank> getDLFileRanks(
196                    int start, int end)
197                    throws com.liferay.portal.kernel.exception.SystemException {
198                    return getService().getDLFileRanks(start, end);
199            }
200    
201            /**
202            * Returns the number of d l file ranks.
203            *
204            * @return the number of d l file ranks
205            * @throws SystemException if a system exception occurred
206            */
207            public static int getDLFileRanksCount()
208                    throws com.liferay.portal.kernel.exception.SystemException {
209                    return getService().getDLFileRanksCount();
210            }
211    
212            /**
213            * Updates the d l file rank in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
214            *
215            * @param dlFileRank the d l file rank
216            * @return the d l file rank that was updated
217            * @throws SystemException if a system exception occurred
218            */
219            public static com.liferay.portlet.documentlibrary.model.DLFileRank updateDLFileRank(
220                    com.liferay.portlet.documentlibrary.model.DLFileRank dlFileRank)
221                    throws com.liferay.portal.kernel.exception.SystemException {
222                    return getService().updateDLFileRank(dlFileRank);
223            }
224    
225            /**
226            * Updates the d l file rank in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
227            *
228            * @param dlFileRank the d l file rank
229            * @param merge whether to merge the d l file rank 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.
230            * @return the d l file rank that was updated
231            * @throws SystemException if a system exception occurred
232            */
233            public static com.liferay.portlet.documentlibrary.model.DLFileRank updateDLFileRank(
234                    com.liferay.portlet.documentlibrary.model.DLFileRank dlFileRank,
235                    boolean merge)
236                    throws com.liferay.portal.kernel.exception.SystemException {
237                    return getService().updateDLFileRank(dlFileRank, merge);
238            }
239    
240            /**
241            * Returns the Spring bean ID for this bean.
242            *
243            * @return the Spring bean ID for this bean
244            */
245            public static java.lang.String getBeanIdentifier() {
246                    return getService().getBeanIdentifier();
247            }
248    
249            /**
250            * Sets the Spring bean ID for this bean.
251            *
252            * @param beanIdentifier the Spring bean ID for this bean
253            */
254            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
255                    getService().setBeanIdentifier(beanIdentifier);
256            }
257    
258            public static com.liferay.portlet.documentlibrary.model.DLFileRank addFileRank(
259                    long groupId, long companyId, long userId, long fileEntryId,
260                    com.liferay.portal.service.ServiceContext serviceContext)
261                    throws com.liferay.portal.kernel.exception.SystemException {
262                    return getService()
263                                       .addFileRank(groupId, companyId, userId, fileEntryId,
264                            serviceContext);
265            }
266    
267            /**
268            * @deprecated {@link #addFileRank(long, long, long, long, ServiceContext)}
269            */
270            public static com.liferay.portlet.documentlibrary.model.DLFileRank addFileRank(
271                    long groupId, long companyId, long userId, long folderId,
272                    java.lang.String name,
273                    com.liferay.portal.service.ServiceContext serviceContext)
274                    throws com.liferay.portal.kernel.exception.SystemException {
275                    return getService()
276                                       .addFileRank(groupId, companyId, userId, folderId, name,
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 fileRank)
287                    throws com.liferay.portal.kernel.exception.SystemException {
288                    getService().deleteFileRank(fileRank);
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            /**
298            * @deprecated {@link #deleteFileRanksByFileEntryId(long)}
299            */
300            public static void deleteFileRanks(long fileEntryId)
301                    throws com.liferay.portal.kernel.exception.SystemException {
302                    getService().deleteFileRanks(fileEntryId);
303            }
304    
305            public static void deleteFileRanksByFileEntryId(long fileEntryId)
306                    throws com.liferay.portal.kernel.exception.SystemException {
307                    getService().deleteFileRanksByFileEntryId(fileEntryId);
308            }
309    
310            public static void deleteFileRanksByUserId(long userId)
311                    throws com.liferay.portal.kernel.exception.SystemException {
312                    getService().deleteFileRanksByUserId(userId);
313            }
314    
315            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileRank> getFileRanks(
316                    long groupId, long userId)
317                    throws com.liferay.portal.kernel.exception.SystemException {
318                    return getService().getFileRanks(groupId, userId);
319            }
320    
321            /**
322            * @deprecated {@link #getFileRanks(long, long)}
323            */
324            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileRank> getFileRanks(
325                    long groupId, long userId, int start, int end)
326                    throws com.liferay.portal.kernel.exception.SystemException {
327                    return getService().getFileRanks(groupId, userId, start, end);
328            }
329    
330            public static com.liferay.portlet.documentlibrary.model.DLFileRank updateFileRank(
331                    long groupId, long companyId, long userId, long fileEntryId,
332                    com.liferay.portal.service.ServiceContext serviceContext)
333                    throws com.liferay.portal.kernel.exception.SystemException {
334                    return getService()
335                                       .updateFileRank(groupId, companyId, userId, fileEntryId,
336                            serviceContext);
337            }
338    
339            /**
340            * @deprecated {@link #updateFileRank(long, long, long, long,
341            ServiceContext)}
342            */
343            public static com.liferay.portlet.documentlibrary.model.DLFileRank updateFileRank(
344                    long groupId, long companyId, long userId, long folderId,
345                    java.lang.String name,
346                    com.liferay.portal.service.ServiceContext serviceContext)
347                    throws com.liferay.portal.kernel.exception.SystemException {
348                    return getService()
349                                       .updateFileRank(groupId, companyId, userId, folderId, name,
350                            serviceContext);
351            }
352    
353            public static DLFileRankLocalService getService() {
354                    if (_service == null) {
355                            _service = (DLFileRankLocalService)PortalBeanLocatorUtil.locate(DLFileRankLocalService.class.getName());
356    
357                            ReferenceRegistry.registerReference(DLFileRankLocalServiceUtil.class,
358                                    "_service");
359                            MethodCache.remove(DLFileRankLocalService.class);
360                    }
361    
362                    return _service;
363            }
364    
365            public void setService(DLFileRankLocalService service) {
366                    MethodCache.remove(DLFileRankLocalService.class);
367    
368                    _service = service;
369    
370                    ReferenceRegistry.registerReference(DLFileRankLocalServiceUtil.class,
371                            "_service");
372                    MethodCache.remove(DLFileRankLocalService.class);
373            }
374    
375            private static DLFileRankLocalService _service;
376    }