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 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.
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 DLFileShortcutLocalService
029     * @see com.liferay.portlet.documentlibrary.service.base.DLFileShortcutLocalServiceBaseImpl
030     * @see com.liferay.portlet.documentlibrary.service.impl.DLFileShortcutLocalServiceImpl
031     * @generated
032     */
033    public class DLFileShortcutLocalServiceUtil {
034            /*
035             * NOTE FOR DEVELOPERS:
036             *
037             * 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.
038             */
039    
040            /**
041            * Adds the document library file shortcut to the database. Also notifies the appropriate model listeners.
042            *
043            * @param dlFileShortcut the document library file shortcut
044            * @return the document library file shortcut that was added
045            * @throws SystemException if a system exception occurred
046            */
047            public static com.liferay.portlet.documentlibrary.model.DLFileShortcut addDLFileShortcut(
048                    com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut)
049                    throws com.liferay.portal.kernel.exception.SystemException {
050                    return getService().addDLFileShortcut(dlFileShortcut);
051            }
052    
053            /**
054            * Creates a new document library file shortcut with the primary key. Does not add the document library file shortcut to the database.
055            *
056            * @param fileShortcutId the primary key for the new document library file shortcut
057            * @return the new document library file shortcut
058            */
059            public static com.liferay.portlet.documentlibrary.model.DLFileShortcut createDLFileShortcut(
060                    long fileShortcutId) {
061                    return getService().createDLFileShortcut(fileShortcutId);
062            }
063    
064            /**
065            * Deletes the document library file shortcut with the primary key from the database. Also notifies the appropriate model listeners.
066            *
067            * @param fileShortcutId the primary key of the document library file shortcut
068            * @return the document library file shortcut that was removed
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 com.liferay.portlet.documentlibrary.model.DLFileShortcut deleteDLFileShortcut(
073                    long fileShortcutId)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException {
076                    return getService().deleteDLFileShortcut(fileShortcutId);
077            }
078    
079            /**
080            * Deletes the document library file shortcut from the database. Also notifies the appropriate model listeners.
081            *
082            * @param dlFileShortcut the document library file shortcut
083            * @return the document library file shortcut that was removed
084            * @throws SystemException if a system exception occurred
085            */
086            public static com.liferay.portlet.documentlibrary.model.DLFileShortcut deleteDLFileShortcut(
087                    com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut)
088                    throws com.liferay.portal.kernel.exception.SystemException {
089                    return getService().deleteDLFileShortcut(dlFileShortcut);
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.DLFileShortcutModelImpl}. 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.DLFileShortcutModelImpl}. 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.DLFileShortcut fetchDLFileShortcut(
168                    long fileShortcutId)
169                    throws com.liferay.portal.kernel.exception.SystemException {
170                    return getService().fetchDLFileShortcut(fileShortcutId);
171            }
172    
173            /**
174            * Returns the document library file shortcut with the primary key.
175            *
176            * @param fileShortcutId the primary key of the document library file shortcut
177            * @return the document library file shortcut
178            * @throws PortalException if a document library file shortcut 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.DLFileShortcut getDLFileShortcut(
182                    long fileShortcutId)
183                    throws com.liferay.portal.kernel.exception.PortalException,
184                            com.liferay.portal.kernel.exception.SystemException {
185                    return getService().getDLFileShortcut(fileShortcutId);
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 the document library file shortcut with the UUID in the group.
197            *
198            * @param uuid the UUID of document library file shortcut
199            * @param groupId the group id of the document library file shortcut
200            * @return the document library file shortcut
201            * @throws PortalException if a document library file shortcut with the UUID in the group could not be found
202            * @throws SystemException if a system exception occurred
203            */
204            public static com.liferay.portlet.documentlibrary.model.DLFileShortcut getDLFileShortcutByUuidAndGroupId(
205                    java.lang.String uuid, long groupId)
206                    throws com.liferay.portal.kernel.exception.PortalException,
207                            com.liferay.portal.kernel.exception.SystemException {
208                    return getService().getDLFileShortcutByUuidAndGroupId(uuid, groupId);
209            }
210    
211            /**
212            * Returns a range of all the document library file shortcuts.
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.DLFileShortcutModelImpl}. 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 shortcuts
219            * @param end the upper bound of the range of document library file shortcuts (not inclusive)
220            * @return the range of document library file shortcuts
221            * @throws SystemException if a system exception occurred
222            */
223            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileShortcut> getDLFileShortcuts(
224                    int start, int end)
225                    throws com.liferay.portal.kernel.exception.SystemException {
226                    return getService().getDLFileShortcuts(start, end);
227            }
228    
229            /**
230            * Returns the number of document library file shortcuts.
231            *
232            * @return the number of document library file shortcuts
233            * @throws SystemException if a system exception occurred
234            */
235            public static int getDLFileShortcutsCount()
236                    throws com.liferay.portal.kernel.exception.SystemException {
237                    return getService().getDLFileShortcutsCount();
238            }
239    
240            /**
241            * Updates the document library file shortcut in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
242            *
243            * @param dlFileShortcut the document library file shortcut
244            * @return the document library file shortcut that was updated
245            * @throws SystemException if a system exception occurred
246            */
247            public static com.liferay.portlet.documentlibrary.model.DLFileShortcut updateDLFileShortcut(
248                    com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut)
249                    throws com.liferay.portal.kernel.exception.SystemException {
250                    return getService().updateDLFileShortcut(dlFileShortcut);
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.DLFileShortcut addFileShortcut(
272                    long userId, long groupId, long folderId, long toFileEntryId,
273                    com.liferay.portal.service.ServiceContext serviceContext)
274                    throws com.liferay.portal.kernel.exception.PortalException,
275                            com.liferay.portal.kernel.exception.SystemException {
276                    return getService()
277                                       .addFileShortcut(userId, groupId, folderId, toFileEntryId,
278                            serviceContext);
279            }
280    
281            public static void addFileShortcutResources(
282                    com.liferay.portlet.documentlibrary.model.DLFileShortcut fileShortcut,
283                    boolean addGroupPermissions, boolean addGuestPermissions)
284                    throws com.liferay.portal.kernel.exception.PortalException,
285                            com.liferay.portal.kernel.exception.SystemException {
286                    getService()
287                            .addFileShortcutResources(fileShortcut, addGroupPermissions,
288                            addGuestPermissions);
289            }
290    
291            public static void addFileShortcutResources(
292                    com.liferay.portlet.documentlibrary.model.DLFileShortcut fileShortcut,
293                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
294                    throws com.liferay.portal.kernel.exception.PortalException,
295                            com.liferay.portal.kernel.exception.SystemException {
296                    getService()
297                            .addFileShortcutResources(fileShortcut, groupPermissions,
298                            guestPermissions);
299            }
300    
301            public static void addFileShortcutResources(long fileShortcutId,
302                    boolean addGroupPermissions, boolean addGuestPermissions)
303                    throws com.liferay.portal.kernel.exception.PortalException,
304                            com.liferay.portal.kernel.exception.SystemException {
305                    getService()
306                            .addFileShortcutResources(fileShortcutId, addGroupPermissions,
307                            addGuestPermissions);
308            }
309    
310            public static void addFileShortcutResources(long fileShortcutId,
311                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
312                    throws com.liferay.portal.kernel.exception.PortalException,
313                            com.liferay.portal.kernel.exception.SystemException {
314                    getService()
315                            .addFileShortcutResources(fileShortcutId, groupPermissions,
316                            guestPermissions);
317            }
318    
319            public static void deleteFileShortcut(
320                    com.liferay.portlet.documentlibrary.model.DLFileShortcut fileShortcut)
321                    throws com.liferay.portal.kernel.exception.PortalException,
322                            com.liferay.portal.kernel.exception.SystemException {
323                    getService().deleteFileShortcut(fileShortcut);
324            }
325    
326            public static void deleteFileShortcut(long fileShortcutId)
327                    throws com.liferay.portal.kernel.exception.PortalException,
328                            com.liferay.portal.kernel.exception.SystemException {
329                    getService().deleteFileShortcut(fileShortcutId);
330            }
331    
332            public static void deleteFileShortcuts(long toFileEntryId)
333                    throws com.liferay.portal.kernel.exception.PortalException,
334                            com.liferay.portal.kernel.exception.SystemException {
335                    getService().deleteFileShortcuts(toFileEntryId);
336            }
337    
338            public static void deleteFileShortcuts(long groupId, long folderId)
339                    throws com.liferay.portal.kernel.exception.PortalException,
340                            com.liferay.portal.kernel.exception.SystemException {
341                    getService().deleteFileShortcuts(groupId, folderId);
342            }
343    
344            public static void deleteFileShortcuts(long groupId, long folderId,
345                    boolean includeTrashedEntries)
346                    throws com.liferay.portal.kernel.exception.PortalException,
347                            com.liferay.portal.kernel.exception.SystemException {
348                    getService()
349                            .deleteFileShortcuts(groupId, folderId, includeTrashedEntries);
350            }
351    
352            public static void disableFileShortcuts(long toFileEntryId)
353                    throws com.liferay.portal.kernel.exception.SystemException {
354                    getService().disableFileShortcuts(toFileEntryId);
355            }
356    
357            public static void enableFileShortcuts(long toFileEntryId)
358                    throws com.liferay.portal.kernel.exception.SystemException {
359                    getService().enableFileShortcuts(toFileEntryId);
360            }
361    
362            public static com.liferay.portlet.documentlibrary.model.DLFileShortcut getFileShortcut(
363                    long fileShortcutId)
364                    throws com.liferay.portal.kernel.exception.PortalException,
365                            com.liferay.portal.kernel.exception.SystemException {
366                    return getService().getFileShortcut(fileShortcutId);
367            }
368    
369            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileShortcut> getFileShortcuts(
370                    long groupId, long folderId, boolean active, int status, int start,
371                    int end) throws com.liferay.portal.kernel.exception.SystemException {
372                    return getService()
373                                       .getFileShortcuts(groupId, folderId, active, status, start,
374                            end);
375            }
376    
377            public static int getFileShortcutsCount(long groupId, long folderId,
378                    boolean active, int status)
379                    throws com.liferay.portal.kernel.exception.SystemException {
380                    return getService()
381                                       .getFileShortcutsCount(groupId, folderId, active, status);
382            }
383    
384            public static void updateAsset(long userId,
385                    com.liferay.portlet.documentlibrary.model.DLFileShortcut fileShortcut,
386                    long[] assetCategoryIds, java.lang.String[] assetTagNames)
387                    throws com.liferay.portal.kernel.exception.PortalException,
388                            com.liferay.portal.kernel.exception.SystemException {
389                    getService()
390                            .updateAsset(userId, fileShortcut, assetCategoryIds, assetTagNames);
391            }
392    
393            public static com.liferay.portlet.documentlibrary.model.DLFileShortcut updateFileShortcut(
394                    long userId, long fileShortcutId, long folderId, long toFileEntryId,
395                    com.liferay.portal.service.ServiceContext serviceContext)
396                    throws com.liferay.portal.kernel.exception.PortalException,
397                            com.liferay.portal.kernel.exception.SystemException {
398                    return getService()
399                                       .updateFileShortcut(userId, fileShortcutId, folderId,
400                            toFileEntryId, serviceContext);
401            }
402    
403            public static void updateFileShortcuts(long oldToFileEntryId,
404                    long newToFileEntryId)
405                    throws com.liferay.portal.kernel.exception.SystemException {
406                    getService().updateFileShortcuts(oldToFileEntryId, newToFileEntryId);
407            }
408    
409            public static void updateStatus(long userId, long fileShortcutId,
410                    int status, com.liferay.portal.service.ServiceContext serviceContext)
411                    throws com.liferay.portal.kernel.exception.PortalException,
412                            com.liferay.portal.kernel.exception.SystemException {
413                    getService().updateStatus(userId, fileShortcutId, status, serviceContext);
414            }
415    
416            public static DLFileShortcutLocalService getService() {
417                    if (_service == null) {
418                            _service = (DLFileShortcutLocalService)PortalBeanLocatorUtil.locate(DLFileShortcutLocalService.class.getName());
419    
420                            ReferenceRegistry.registerReference(DLFileShortcutLocalServiceUtil.class,
421                                    "_service");
422                    }
423    
424                    return _service;
425            }
426    
427            /**
428             * @deprecated
429             */
430            public void setService(DLFileShortcutLocalService service) {
431            }
432    
433            private static DLFileShortcutLocalService _service;
434    }