001    /**
002     * Copyright (c) 2000-2013 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.
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.
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.
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            * Updates the document library file shortcut in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
255            *
256            * @param dlFileShortcut the document library file shortcut
257            * @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.
258            * @return the document library file shortcut that was updated
259            * @throws SystemException if a system exception occurred
260            */
261            public static com.liferay.portlet.documentlibrary.model.DLFileShortcut updateDLFileShortcut(
262                    com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut,
263                    boolean merge)
264                    throws com.liferay.portal.kernel.exception.SystemException {
265                    return getService().updateDLFileShortcut(dlFileShortcut, merge);
266            }
267    
268            /**
269            * Returns the Spring bean ID for this bean.
270            *
271            * @return the Spring bean ID for this bean
272            */
273            public static java.lang.String getBeanIdentifier() {
274                    return getService().getBeanIdentifier();
275            }
276    
277            /**
278            * Sets the Spring bean ID for this bean.
279            *
280            * @param beanIdentifier the Spring bean ID for this bean
281            */
282            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
283                    getService().setBeanIdentifier(beanIdentifier);
284            }
285    
286            public static com.liferay.portlet.documentlibrary.model.DLFileShortcut addFileShortcut(
287                    long userId, long groupId, long folderId, long toFileEntryId,
288                    com.liferay.portal.service.ServiceContext serviceContext)
289                    throws com.liferay.portal.kernel.exception.PortalException,
290                            com.liferay.portal.kernel.exception.SystemException {
291                    return getService()
292                                       .addFileShortcut(userId, groupId, folderId, toFileEntryId,
293                            serviceContext);
294            }
295    
296            public static void addFileShortcutResources(
297                    com.liferay.portlet.documentlibrary.model.DLFileShortcut fileShortcut,
298                    boolean addGroupPermissions, boolean addGuestPermissions)
299                    throws com.liferay.portal.kernel.exception.PortalException,
300                            com.liferay.portal.kernel.exception.SystemException {
301                    getService()
302                            .addFileShortcutResources(fileShortcut, addGroupPermissions,
303                            addGuestPermissions);
304            }
305    
306            public static void addFileShortcutResources(
307                    com.liferay.portlet.documentlibrary.model.DLFileShortcut fileShortcut,
308                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
309                    throws com.liferay.portal.kernel.exception.PortalException,
310                            com.liferay.portal.kernel.exception.SystemException {
311                    getService()
312                            .addFileShortcutResources(fileShortcut, groupPermissions,
313                            guestPermissions);
314            }
315    
316            public static void addFileShortcutResources(long fileShortcutId,
317                    boolean addGroupPermissions, boolean addGuestPermissions)
318                    throws com.liferay.portal.kernel.exception.PortalException,
319                            com.liferay.portal.kernel.exception.SystemException {
320                    getService()
321                            .addFileShortcutResources(fileShortcutId, addGroupPermissions,
322                            addGuestPermissions);
323            }
324    
325            public static void addFileShortcutResources(long fileShortcutId,
326                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
327                    throws com.liferay.portal.kernel.exception.PortalException,
328                            com.liferay.portal.kernel.exception.SystemException {
329                    getService()
330                            .addFileShortcutResources(fileShortcutId, groupPermissions,
331                            guestPermissions);
332            }
333    
334            public static void deleteFileShortcut(
335                    com.liferay.portlet.documentlibrary.model.DLFileShortcut fileShortcut)
336                    throws com.liferay.portal.kernel.exception.PortalException,
337                            com.liferay.portal.kernel.exception.SystemException {
338                    getService().deleteFileShortcut(fileShortcut);
339            }
340    
341            public static void deleteFileShortcut(long fileShortcutId)
342                    throws com.liferay.portal.kernel.exception.PortalException,
343                            com.liferay.portal.kernel.exception.SystemException {
344                    getService().deleteFileShortcut(fileShortcutId);
345            }
346    
347            public static void deleteFileShortcuts(long toFileEntryId)
348                    throws com.liferay.portal.kernel.exception.PortalException,
349                            com.liferay.portal.kernel.exception.SystemException {
350                    getService().deleteFileShortcuts(toFileEntryId);
351            }
352    
353            public static com.liferay.portlet.documentlibrary.model.DLFileShortcut getFileShortcut(
354                    long fileShortcutId)
355                    throws com.liferay.portal.kernel.exception.PortalException,
356                            com.liferay.portal.kernel.exception.SystemException {
357                    return getService().getFileShortcut(fileShortcutId);
358            }
359    
360            public static void updateAsset(long userId,
361                    com.liferay.portlet.documentlibrary.model.DLFileShortcut fileShortcut,
362                    long[] assetCategoryIds, java.lang.String[] assetTagNames)
363                    throws com.liferay.portal.kernel.exception.PortalException,
364                            com.liferay.portal.kernel.exception.SystemException {
365                    getService()
366                            .updateAsset(userId, fileShortcut, assetCategoryIds, assetTagNames);
367            }
368    
369            public static com.liferay.portlet.documentlibrary.model.DLFileShortcut updateFileShortcut(
370                    long userId, long fileShortcutId, long folderId, long toFileEntryId,
371                    com.liferay.portal.service.ServiceContext serviceContext)
372                    throws com.liferay.portal.kernel.exception.PortalException,
373                            com.liferay.portal.kernel.exception.SystemException {
374                    return getService()
375                                       .updateFileShortcut(userId, fileShortcutId, folderId,
376                            toFileEntryId, serviceContext);
377            }
378    
379            public static void updateFileShortcuts(long oldToFileEntryId,
380                    long newToFileEntryId)
381                    throws com.liferay.portal.kernel.exception.SystemException {
382                    getService().updateFileShortcuts(oldToFileEntryId, newToFileEntryId);
383            }
384    
385            public static DLFileShortcutLocalService getService() {
386                    if (_service == null) {
387                            _service = (DLFileShortcutLocalService)PortalBeanLocatorUtil.locate(DLFileShortcutLocalService.class.getName());
388    
389                            ReferenceRegistry.registerReference(DLFileShortcutLocalServiceUtil.class,
390                                    "_service");
391                    }
392    
393                    return _service;
394            }
395    
396            /**
397             * @deprecated
398             */
399            public void setService(DLFileShortcutLocalService service) {
400            }
401    
402            private static DLFileShortcutLocalService _service;
403    }