001    /**
002     * Copyright (c) 2000-2011 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            /**
162            * Returns the document library file shortcut with the primary key.
163            *
164            * @param fileShortcutId the primary key of the document library file shortcut
165            * @return the document library file shortcut
166            * @throws PortalException if a document library file shortcut 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.DLFileShortcut getDLFileShortcut(
170                    long fileShortcutId)
171                    throws com.liferay.portal.kernel.exception.PortalException,
172                            com.liferay.portal.kernel.exception.SystemException {
173                    return getService().getDLFileShortcut(fileShortcutId);
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 the document library file shortcut with the UUID in the group.
185            *
186            * @param uuid the UUID of document library file shortcut
187            * @param groupId the group id of the document library file shortcut
188            * @return the document library file shortcut
189            * @throws PortalException if a document library file shortcut with the UUID in the group could not be found
190            * @throws SystemException if a system exception occurred
191            */
192            public static com.liferay.portlet.documentlibrary.model.DLFileShortcut getDLFileShortcutByUuidAndGroupId(
193                    java.lang.String uuid, long groupId)
194                    throws com.liferay.portal.kernel.exception.PortalException,
195                            com.liferay.portal.kernel.exception.SystemException {
196                    return getService().getDLFileShortcutByUuidAndGroupId(uuid, groupId);
197            }
198    
199            /**
200            * Returns a range of all the document library file shortcuts.
201            *
202            * <p>
203            * 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.
204            * </p>
205            *
206            * @param start the lower bound of the range of document library file shortcuts
207            * @param end the upper bound of the range of document library file shortcuts (not inclusive)
208            * @return the range of document library file shortcuts
209            * @throws SystemException if a system exception occurred
210            */
211            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileShortcut> getDLFileShortcuts(
212                    int start, int end)
213                    throws com.liferay.portal.kernel.exception.SystemException {
214                    return getService().getDLFileShortcuts(start, end);
215            }
216    
217            /**
218            * Returns the number of document library file shortcuts.
219            *
220            * @return the number of document library file shortcuts
221            * @throws SystemException if a system exception occurred
222            */
223            public static int getDLFileShortcutsCount()
224                    throws com.liferay.portal.kernel.exception.SystemException {
225                    return getService().getDLFileShortcutsCount();
226            }
227    
228            /**
229            * Updates the document library file shortcut in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
230            *
231            * @param dlFileShortcut the document library file shortcut
232            * @return the document library file shortcut that was updated
233            * @throws SystemException if a system exception occurred
234            */
235            public static com.liferay.portlet.documentlibrary.model.DLFileShortcut updateDLFileShortcut(
236                    com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut)
237                    throws com.liferay.portal.kernel.exception.SystemException {
238                    return getService().updateDLFileShortcut(dlFileShortcut);
239            }
240    
241            /**
242            * Updates the document library file shortcut in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
243            *
244            * @param dlFileShortcut the document library file shortcut
245            * @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.
246            * @return the document library file shortcut that was updated
247            * @throws SystemException if a system exception occurred
248            */
249            public static com.liferay.portlet.documentlibrary.model.DLFileShortcut updateDLFileShortcut(
250                    com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut,
251                    boolean merge)
252                    throws com.liferay.portal.kernel.exception.SystemException {
253                    return getService().updateDLFileShortcut(dlFileShortcut, merge);
254            }
255    
256            /**
257            * Returns the Spring bean ID for this bean.
258            *
259            * @return the Spring bean ID for this bean
260            */
261            public static java.lang.String getBeanIdentifier() {
262                    return getService().getBeanIdentifier();
263            }
264    
265            /**
266            * Sets the Spring bean ID for this bean.
267            *
268            * @param beanIdentifier the Spring bean ID for this bean
269            */
270            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
271                    getService().setBeanIdentifier(beanIdentifier);
272            }
273    
274            public static com.liferay.portlet.documentlibrary.model.DLFileShortcut addFileShortcut(
275                    long userId, long groupId, long folderId, long toFileEntryId,
276                    com.liferay.portal.service.ServiceContext serviceContext)
277                    throws com.liferay.portal.kernel.exception.PortalException,
278                            com.liferay.portal.kernel.exception.SystemException {
279                    return getService()
280                                       .addFileShortcut(userId, groupId, folderId, toFileEntryId,
281                            serviceContext);
282            }
283    
284            public static void addFileShortcutResources(
285                    com.liferay.portlet.documentlibrary.model.DLFileShortcut fileShortcut,
286                    boolean addGroupPermissions, boolean addGuestPermissions)
287                    throws com.liferay.portal.kernel.exception.PortalException,
288                            com.liferay.portal.kernel.exception.SystemException {
289                    getService()
290                            .addFileShortcutResources(fileShortcut, addGroupPermissions,
291                            addGuestPermissions);
292            }
293    
294            public static void addFileShortcutResources(
295                    com.liferay.portlet.documentlibrary.model.DLFileShortcut fileShortcut,
296                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
297                    throws com.liferay.portal.kernel.exception.PortalException,
298                            com.liferay.portal.kernel.exception.SystemException {
299                    getService()
300                            .addFileShortcutResources(fileShortcut, groupPermissions,
301                            guestPermissions);
302            }
303    
304            public static void addFileShortcutResources(long fileShortcutId,
305                    boolean addGroupPermissions, boolean addGuestPermissions)
306                    throws com.liferay.portal.kernel.exception.PortalException,
307                            com.liferay.portal.kernel.exception.SystemException {
308                    getService()
309                            .addFileShortcutResources(fileShortcutId, addGroupPermissions,
310                            addGuestPermissions);
311            }
312    
313            public static void addFileShortcutResources(long fileShortcutId,
314                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
315                    throws com.liferay.portal.kernel.exception.PortalException,
316                            com.liferay.portal.kernel.exception.SystemException {
317                    getService()
318                            .addFileShortcutResources(fileShortcutId, groupPermissions,
319                            guestPermissions);
320            }
321    
322            public static void deleteFileShortcut(
323                    com.liferay.portlet.documentlibrary.model.DLFileShortcut fileShortcut)
324                    throws com.liferay.portal.kernel.exception.PortalException,
325                            com.liferay.portal.kernel.exception.SystemException {
326                    getService().deleteFileShortcut(fileShortcut);
327            }
328    
329            public static void deleteFileShortcut(long fileShortcutId)
330                    throws com.liferay.portal.kernel.exception.PortalException,
331                            com.liferay.portal.kernel.exception.SystemException {
332                    getService().deleteFileShortcut(fileShortcutId);
333            }
334    
335            public static void deleteFileShortcuts(long toFileEntryId)
336                    throws com.liferay.portal.kernel.exception.PortalException,
337                            com.liferay.portal.kernel.exception.SystemException {
338                    getService().deleteFileShortcuts(toFileEntryId);
339            }
340    
341            public static com.liferay.portlet.documentlibrary.model.DLFileShortcut getFileShortcut(
342                    long fileShortcutId)
343                    throws com.liferay.portal.kernel.exception.PortalException,
344                            com.liferay.portal.kernel.exception.SystemException {
345                    return getService().getFileShortcut(fileShortcutId);
346            }
347    
348            public static void updateAsset(long userId,
349                    com.liferay.portlet.documentlibrary.model.DLFileShortcut fileShortcut,
350                    long[] assetCategoryIds, java.lang.String[] assetTagNames)
351                    throws com.liferay.portal.kernel.exception.PortalException,
352                            com.liferay.portal.kernel.exception.SystemException {
353                    getService()
354                            .updateAsset(userId, fileShortcut, assetCategoryIds, assetTagNames);
355            }
356    
357            public static com.liferay.portlet.documentlibrary.model.DLFileShortcut updateFileShortcut(
358                    long userId, long fileShortcutId, long folderId, long toFileEntryId,
359                    com.liferay.portal.service.ServiceContext serviceContext)
360                    throws com.liferay.portal.kernel.exception.PortalException,
361                            com.liferay.portal.kernel.exception.SystemException {
362                    return getService()
363                                       .updateFileShortcut(userId, fileShortcutId, folderId,
364                            toFileEntryId, serviceContext);
365            }
366    
367            public static void updateFileShortcuts(long oldToFileEntryId,
368                    long newToFileEntryId)
369                    throws com.liferay.portal.kernel.exception.SystemException {
370                    getService().updateFileShortcuts(oldToFileEntryId, newToFileEntryId);
371            }
372    
373            public static DLFileShortcutLocalService getService() {
374                    if (_service == null) {
375                            _service = (DLFileShortcutLocalService)PortalBeanLocatorUtil.locate(DLFileShortcutLocalService.class.getName());
376    
377                            ReferenceRegistry.registerReference(DLFileShortcutLocalServiceUtil.class,
378                                    "_service");
379                            MethodCache.remove(DLFileShortcutLocalService.class);
380                    }
381    
382                    return _service;
383            }
384    
385            public void setService(DLFileShortcutLocalService service) {
386                    MethodCache.remove(DLFileShortcutLocalService.class);
387    
388                    _service = service;
389    
390                    ReferenceRegistry.registerReference(DLFileShortcutLocalServiceUtil.class,
391                            "_service");
392                    MethodCache.remove(DLFileShortcutLocalService.class);
393            }
394    
395            private static DLFileShortcutLocalService _service;
396    }