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.MethodCache;
019    import com.liferay.portal.kernel.util.ReferenceRegistry;
020    
021    /**
022     * The utility for the document library file shortcut local service. This utility wraps {@link com.liferay.portlet.documentlibrary.service.impl.DLFileShortcutLocalServiceImpl} 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 DLFileShortcutLocalService
030     * @see com.liferay.portlet.documentlibrary.service.base.DLFileShortcutLocalServiceBaseImpl
031     * @see com.liferay.portlet.documentlibrary.service.impl.DLFileShortcutLocalServiceImpl
032     * @generated
033     */
034    public class DLFileShortcutLocalServiceUtil {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.documentlibrary.service.impl.DLFileShortcutLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
039             */
040    
041            /**
042            * Adds the document library file shortcut to the database. Also notifies the appropriate model listeners.
043            *
044            * @param dlFileShortcut the document library file shortcut
045            * @return the document library file shortcut that was added
046            * @throws SystemException if a system exception occurred
047            */
048            public static com.liferay.portlet.documentlibrary.model.DLFileShortcut addDLFileShortcut(
049                    com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut)
050                    throws com.liferay.portal.kernel.exception.SystemException {
051                    return getService().addDLFileShortcut(dlFileShortcut);
052            }
053    
054            /**
055            * Creates a new document library file shortcut with the primary key. Does not add the document library file shortcut to the database.
056            *
057            * @param fileShortcutId the primary key for the new document library file shortcut
058            * @return the new document library file shortcut
059            */
060            public static com.liferay.portlet.documentlibrary.model.DLFileShortcut createDLFileShortcut(
061                    long fileShortcutId) {
062                    return getService().createDLFileShortcut(fileShortcutId);
063            }
064    
065            /**
066            * Deletes the document library file shortcut with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param fileShortcutId the primary key of the document library file shortcut
069            * @throws PortalException if a document library file shortcut with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static void deleteDLFileShortcut(long fileShortcutId)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException {
075                    getService().deleteDLFileShortcut(fileShortcutId);
076            }
077    
078            /**
079            * Deletes the document library file shortcut from the database. Also notifies the appropriate model listeners.
080            *
081            * @param dlFileShortcut the document library file shortcut
082            * @throws SystemException if a system exception occurred
083            */
084            public static void deleteDLFileShortcut(
085                    com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut)
086                    throws com.liferay.portal.kernel.exception.SystemException {
087                    getService().deleteDLFileShortcut(dlFileShortcut);
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.DLFileShortcut fetchDLFileShortcut(
162                    long fileShortcutId)
163                    throws com.liferay.portal.kernel.exception.SystemException {
164                    return getService().fetchDLFileShortcut(fileShortcutId);
165            }
166    
167            /**
168            * Returns the document library file shortcut with the primary key.
169            *
170            * @param fileShortcutId the primary key of the document library file shortcut
171            * @return the document library file shortcut
172            * @throws PortalException if a document library file shortcut 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.DLFileShortcut getDLFileShortcut(
176                    long fileShortcutId)
177                    throws com.liferay.portal.kernel.exception.PortalException,
178                            com.liferay.portal.kernel.exception.SystemException {
179                    return getService().getDLFileShortcut(fileShortcutId);
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 the document library file shortcut with the UUID in the group.
191            *
192            * @param uuid the UUID of document library file shortcut
193            * @param groupId the group id of the document library file shortcut
194            * @return the document library file shortcut
195            * @throws PortalException if a document library file shortcut with the UUID in the group could not be found
196            * @throws SystemException if a system exception occurred
197            */
198            public static com.liferay.portlet.documentlibrary.model.DLFileShortcut getDLFileShortcutByUuidAndGroupId(
199                    java.lang.String uuid, long groupId)
200                    throws com.liferay.portal.kernel.exception.PortalException,
201                            com.liferay.portal.kernel.exception.SystemException {
202                    return getService().getDLFileShortcutByUuidAndGroupId(uuid, groupId);
203            }
204    
205            /**
206            * Returns a range of all the document library file shortcuts.
207            *
208            * <p>
209            * 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.
210            * </p>
211            *
212            * @param start the lower bound of the range of document library file shortcuts
213            * @param end the upper bound of the range of document library file shortcuts (not inclusive)
214            * @return the range of document library file shortcuts
215            * @throws SystemException if a system exception occurred
216            */
217            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileShortcut> getDLFileShortcuts(
218                    int start, int end)
219                    throws com.liferay.portal.kernel.exception.SystemException {
220                    return getService().getDLFileShortcuts(start, end);
221            }
222    
223            /**
224            * Returns the number of document library file shortcuts.
225            *
226            * @return the number of document library file shortcuts
227            * @throws SystemException if a system exception occurred
228            */
229            public static int getDLFileShortcutsCount()
230                    throws com.liferay.portal.kernel.exception.SystemException {
231                    return getService().getDLFileShortcutsCount();
232            }
233    
234            /**
235            * Updates the document library file shortcut in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
236            *
237            * @param dlFileShortcut the document library file shortcut
238            * @return the document library file shortcut that was updated
239            * @throws SystemException if a system exception occurred
240            */
241            public static com.liferay.portlet.documentlibrary.model.DLFileShortcut updateDLFileShortcut(
242                    com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut)
243                    throws com.liferay.portal.kernel.exception.SystemException {
244                    return getService().updateDLFileShortcut(dlFileShortcut);
245            }
246    
247            /**
248            * Updates the document library file shortcut in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
249            *
250            * @param dlFileShortcut the document library file shortcut
251            * @param merge whether to merge the document library file shortcut 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.
252            * @return the document library file shortcut that was updated
253            * @throws SystemException if a system exception occurred
254            */
255            public static com.liferay.portlet.documentlibrary.model.DLFileShortcut updateDLFileShortcut(
256                    com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut,
257                    boolean merge)
258                    throws com.liferay.portal.kernel.exception.SystemException {
259                    return getService().updateDLFileShortcut(dlFileShortcut, merge);
260            }
261    
262            /**
263            * Returns the Spring bean ID for this bean.
264            *
265            * @return the Spring bean ID for this bean
266            */
267            public static java.lang.String getBeanIdentifier() {
268                    return getService().getBeanIdentifier();
269            }
270    
271            /**
272            * Sets the Spring bean ID for this bean.
273            *
274            * @param beanIdentifier the Spring bean ID for this bean
275            */
276            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
277                    getService().setBeanIdentifier(beanIdentifier);
278            }
279    
280            public static com.liferay.portlet.documentlibrary.model.DLFileShortcut addFileShortcut(
281                    long userId, long groupId, long folderId, long toFileEntryId,
282                    com.liferay.portal.service.ServiceContext serviceContext)
283                    throws com.liferay.portal.kernel.exception.PortalException,
284                            com.liferay.portal.kernel.exception.SystemException {
285                    return getService()
286                                       .addFileShortcut(userId, groupId, folderId, toFileEntryId,
287                            serviceContext);
288            }
289    
290            public static void addFileShortcutResources(
291                    com.liferay.portlet.documentlibrary.model.DLFileShortcut fileShortcut,
292                    boolean addGroupPermissions, boolean addGuestPermissions)
293                    throws com.liferay.portal.kernel.exception.PortalException,
294                            com.liferay.portal.kernel.exception.SystemException {
295                    getService()
296                            .addFileShortcutResources(fileShortcut, addGroupPermissions,
297                            addGuestPermissions);
298            }
299    
300            public static void addFileShortcutResources(
301                    com.liferay.portlet.documentlibrary.model.DLFileShortcut fileShortcut,
302                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
303                    throws com.liferay.portal.kernel.exception.PortalException,
304                            com.liferay.portal.kernel.exception.SystemException {
305                    getService()
306                            .addFileShortcutResources(fileShortcut, groupPermissions,
307                            guestPermissions);
308            }
309    
310            public static void addFileShortcutResources(long fileShortcutId,
311                    boolean addGroupPermissions, boolean addGuestPermissions)
312                    throws com.liferay.portal.kernel.exception.PortalException,
313                            com.liferay.portal.kernel.exception.SystemException {
314                    getService()
315                            .addFileShortcutResources(fileShortcutId, addGroupPermissions,
316                            addGuestPermissions);
317            }
318    
319            public static void addFileShortcutResources(long fileShortcutId,
320                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
321                    throws com.liferay.portal.kernel.exception.PortalException,
322                            com.liferay.portal.kernel.exception.SystemException {
323                    getService()
324                            .addFileShortcutResources(fileShortcutId, groupPermissions,
325                            guestPermissions);
326            }
327    
328            public static void deleteFileShortcut(
329                    com.liferay.portlet.documentlibrary.model.DLFileShortcut fileShortcut)
330                    throws com.liferay.portal.kernel.exception.PortalException,
331                            com.liferay.portal.kernel.exception.SystemException {
332                    getService().deleteFileShortcut(fileShortcut);
333            }
334    
335            public static void deleteFileShortcut(long fileShortcutId)
336                    throws com.liferay.portal.kernel.exception.PortalException,
337                            com.liferay.portal.kernel.exception.SystemException {
338                    getService().deleteFileShortcut(fileShortcutId);
339            }
340    
341            public static void deleteFileShortcuts(long toFileEntryId)
342                    throws com.liferay.portal.kernel.exception.PortalException,
343                            com.liferay.portal.kernel.exception.SystemException {
344                    getService().deleteFileShortcuts(toFileEntryId);
345            }
346    
347            public static com.liferay.portlet.documentlibrary.model.DLFileShortcut getFileShortcut(
348                    long fileShortcutId)
349                    throws com.liferay.portal.kernel.exception.PortalException,
350                            com.liferay.portal.kernel.exception.SystemException {
351                    return getService().getFileShortcut(fileShortcutId);
352            }
353    
354            public static void updateAsset(long userId,
355                    com.liferay.portlet.documentlibrary.model.DLFileShortcut fileShortcut,
356                    long[] assetCategoryIds, java.lang.String[] assetTagNames)
357                    throws com.liferay.portal.kernel.exception.PortalException,
358                            com.liferay.portal.kernel.exception.SystemException {
359                    getService()
360                            .updateAsset(userId, fileShortcut, assetCategoryIds, assetTagNames);
361            }
362    
363            public static com.liferay.portlet.documentlibrary.model.DLFileShortcut updateFileShortcut(
364                    long userId, long fileShortcutId, long folderId, long toFileEntryId,
365                    com.liferay.portal.service.ServiceContext serviceContext)
366                    throws com.liferay.portal.kernel.exception.PortalException,
367                            com.liferay.portal.kernel.exception.SystemException {
368                    return getService()
369                                       .updateFileShortcut(userId, fileShortcutId, folderId,
370                            toFileEntryId, serviceContext);
371            }
372    
373            public static void updateFileShortcuts(long oldToFileEntryId,
374                    long newToFileEntryId)
375                    throws com.liferay.portal.kernel.exception.SystemException {
376                    getService().updateFileShortcuts(oldToFileEntryId, newToFileEntryId);
377            }
378    
379            public static DLFileShortcutLocalService getService() {
380                    if (_service == null) {
381                            _service = (DLFileShortcutLocalService)PortalBeanLocatorUtil.locate(DLFileShortcutLocalService.class.getName());
382    
383                            ReferenceRegistry.registerReference(DLFileShortcutLocalServiceUtil.class,
384                                    "_service");
385                            MethodCache.remove(DLFileShortcutLocalService.class);
386                    }
387    
388                    return _service;
389            }
390    
391            public void setService(DLFileShortcutLocalService service) {
392                    MethodCache.remove(DLFileShortcutLocalService.class);
393    
394                    _service = service;
395    
396                    ReferenceRegistry.registerReference(DLFileShortcutLocalServiceUtil.class,
397                            "_service");
398                    MethodCache.remove(DLFileShortcutLocalService.class);
399            }
400    
401            private static DLFileShortcutLocalService _service;
402    }