001    /**
002     * Copyright (c) 2000-2010 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    
019    /**
020     * The utility for the d l 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.
021     *
022     * <p>
023     * 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.
024     * </p>
025     *
026     * <p>
027     * 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.
028     * </p>
029     *
030     * @author Brian Wing Shun Chan
031     * @see DLFileShortcutLocalService
032     * @see com.liferay.portlet.documentlibrary.service.base.DLFileShortcutLocalServiceBaseImpl
033     * @see com.liferay.portlet.documentlibrary.service.impl.DLFileShortcutLocalServiceImpl
034     * @generated
035     */
036    public class DLFileShortcutLocalServiceUtil {
037            /**
038            * Adds the d l file shortcut to the database. Also notifies the appropriate model listeners.
039            *
040            * @param dlFileShortcut the d l file shortcut to add
041            * @return the d l file shortcut that was added
042            * @throws SystemException if a system exception occurred
043            */
044            public static com.liferay.portlet.documentlibrary.model.DLFileShortcut addDLFileShortcut(
045                    com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut)
046                    throws com.liferay.portal.kernel.exception.SystemException {
047                    return getService().addDLFileShortcut(dlFileShortcut);
048            }
049    
050            /**
051            * Creates a new d l file shortcut with the primary key. Does not add the d l file shortcut to the database.
052            *
053            * @param fileShortcutId the primary key for the new d l file shortcut
054            * @return the new d l file shortcut
055            */
056            public static com.liferay.portlet.documentlibrary.model.DLFileShortcut createDLFileShortcut(
057                    long fileShortcutId) {
058                    return getService().createDLFileShortcut(fileShortcutId);
059            }
060    
061            /**
062            * Deletes the d l file shortcut with the primary key from the database. Also notifies the appropriate model listeners.
063            *
064            * @param fileShortcutId the primary key of the d l file shortcut to delete
065            * @throws PortalException if a d l file shortcut with the primary key could not be found
066            * @throws SystemException if a system exception occurred
067            */
068            public static void deleteDLFileShortcut(long fileShortcutId)
069                    throws com.liferay.portal.kernel.exception.PortalException,
070                            com.liferay.portal.kernel.exception.SystemException {
071                    getService().deleteDLFileShortcut(fileShortcutId);
072            }
073    
074            /**
075            * Deletes the d l file shortcut from the database. Also notifies the appropriate model listeners.
076            *
077            * @param dlFileShortcut the d l file shortcut to delete
078            * @throws SystemException if a system exception occurred
079            */
080            public static void deleteDLFileShortcut(
081                    com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut)
082                    throws com.liferay.portal.kernel.exception.SystemException {
083                    getService().deleteDLFileShortcut(dlFileShortcut);
084            }
085    
086            /**
087            * Performs a dynamic query on the database and returns the matching rows.
088            *
089            * @param dynamicQuery the dynamic query to search with
090            * @return the matching rows
091            * @throws SystemException if a system exception occurred
092            */
093            @SuppressWarnings("rawtypes")
094            public static java.util.List dynamicQuery(
095                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
096                    throws com.liferay.portal.kernel.exception.SystemException {
097                    return getService().dynamicQuery(dynamicQuery);
098            }
099    
100            /**
101            * Performs a dynamic query on the database and returns a range of the matching rows.
102            *
103            * <p>
104            * 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.
105            * </p>
106            *
107            * @param dynamicQuery the dynamic query to search with
108            * @param start the lower bound of the range of model instances to return
109            * @param end the upper bound of the range of model instances to return (not inclusive)
110            * @return the range of matching rows
111            * @throws SystemException if a system exception occurred
112            */
113            @SuppressWarnings("rawtypes")
114            public static java.util.List dynamicQuery(
115                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
116                    int end) throws com.liferay.portal.kernel.exception.SystemException {
117                    return getService().dynamicQuery(dynamicQuery, start, end);
118            }
119    
120            /**
121            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
122            *
123            * <p>
124            * 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.
125            * </p>
126            *
127            * @param dynamicQuery the dynamic query to search with
128            * @param start the lower bound of the range of model instances to return
129            * @param end the upper bound of the range of model instances to return (not inclusive)
130            * @param orderByComparator the comparator to order the results by
131            * @return the ordered range of matching rows
132            * @throws SystemException if a system exception occurred
133            */
134            @SuppressWarnings("rawtypes")
135            public static java.util.List dynamicQuery(
136                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
137                    int end,
138                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
139                    throws com.liferay.portal.kernel.exception.SystemException {
140                    return getService()
141                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
142            }
143    
144            /**
145            * Counts the number of rows that match the dynamic query.
146            *
147            * @param dynamicQuery the dynamic query to search with
148            * @return the number of rows that match the dynamic query
149            * @throws SystemException if a system exception occurred
150            */
151            public static long dynamicQueryCount(
152                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
153                    throws com.liferay.portal.kernel.exception.SystemException {
154                    return getService().dynamicQueryCount(dynamicQuery);
155            }
156    
157            /**
158            * Gets the d l file shortcut with the primary key.
159            *
160            * @param fileShortcutId the primary key of the d l file shortcut to get
161            * @return the d l file shortcut
162            * @throws PortalException if a d l file shortcut with the primary key could not be found
163            * @throws SystemException if a system exception occurred
164            */
165            public static com.liferay.portlet.documentlibrary.model.DLFileShortcut getDLFileShortcut(
166                    long fileShortcutId)
167                    throws com.liferay.portal.kernel.exception.PortalException,
168                            com.liferay.portal.kernel.exception.SystemException {
169                    return getService().getDLFileShortcut(fileShortcutId);
170            }
171    
172            /**
173            * Gets the d l file shortcut with the UUID and group id.
174            *
175            * @param uuid the UUID of d l file shortcut to get
176            * @param groupId the group id of the d l file shortcut to get
177            * @return the d l file shortcut
178            * @throws PortalException if a d l file shortcut with the UUID and group id could not be found
179            * @throws SystemException if a system exception occurred
180            */
181            public static com.liferay.portlet.documentlibrary.model.DLFileShortcut getDLFileShortcutByUuidAndGroupId(
182                    java.lang.String uuid, long groupId)
183                    throws com.liferay.portal.kernel.exception.PortalException,
184                            com.liferay.portal.kernel.exception.SystemException {
185                    return getService().getDLFileShortcutByUuidAndGroupId(uuid, groupId);
186            }
187    
188            /**
189            * Gets a range of all the d l file shortcuts.
190            *
191            * <p>
192            * 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.
193            * </p>
194            *
195            * @param start the lower bound of the range of d l file shortcuts to return
196            * @param end the upper bound of the range of d l file shortcuts to return (not inclusive)
197            * @return the range of d l file shortcuts
198            * @throws SystemException if a system exception occurred
199            */
200            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFileShortcut> getDLFileShortcuts(
201                    int start, int end)
202                    throws com.liferay.portal.kernel.exception.SystemException {
203                    return getService().getDLFileShortcuts(start, end);
204            }
205    
206            /**
207            * Gets the number of d l file shortcuts.
208            *
209            * @return the number of d l file shortcuts
210            * @throws SystemException if a system exception occurred
211            */
212            public static int getDLFileShortcutsCount()
213                    throws com.liferay.portal.kernel.exception.SystemException {
214                    return getService().getDLFileShortcutsCount();
215            }
216    
217            /**
218            * Updates the d l file shortcut in the database. Also notifies the appropriate model listeners.
219            *
220            * @param dlFileShortcut the d l file shortcut to update
221            * @return the d l file shortcut that was updated
222            * @throws SystemException if a system exception occurred
223            */
224            public static com.liferay.portlet.documentlibrary.model.DLFileShortcut updateDLFileShortcut(
225                    com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut)
226                    throws com.liferay.portal.kernel.exception.SystemException {
227                    return getService().updateDLFileShortcut(dlFileShortcut);
228            }
229    
230            /**
231            * Updates the d l file shortcut in the database. Also notifies the appropriate model listeners.
232            *
233            * @param dlFileShortcut the d l file shortcut to update
234            * @param merge whether to merge the d l 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.
235            * @return the d l file shortcut that was updated
236            * @throws SystemException if a system exception occurred
237            */
238            public static com.liferay.portlet.documentlibrary.model.DLFileShortcut updateDLFileShortcut(
239                    com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut,
240                    boolean merge)
241                    throws com.liferay.portal.kernel.exception.SystemException {
242                    return getService().updateDLFileShortcut(dlFileShortcut, merge);
243            }
244    
245            public static com.liferay.portlet.documentlibrary.model.DLFileShortcut addFileShortcut(
246                    long userId, long groupId, long folderId, long toFolderId,
247                    java.lang.String toName,
248                    com.liferay.portal.service.ServiceContext serviceContext)
249                    throws com.liferay.portal.kernel.exception.PortalException,
250                            com.liferay.portal.kernel.exception.SystemException {
251                    return getService()
252                                       .addFileShortcut(userId, groupId, folderId, toFolderId,
253                            toName, serviceContext);
254            }
255    
256            public static void addFileShortcutResources(
257                    com.liferay.portlet.documentlibrary.model.DLFileShortcut fileShortcut,
258                    boolean addCommunityPermissions, boolean addGuestPermissions)
259                    throws com.liferay.portal.kernel.exception.PortalException,
260                            com.liferay.portal.kernel.exception.SystemException {
261                    getService()
262                            .addFileShortcutResources(fileShortcut, addCommunityPermissions,
263                            addGuestPermissions);
264            }
265    
266            public static void addFileShortcutResources(
267                    com.liferay.portlet.documentlibrary.model.DLFileShortcut fileShortcut,
268                    java.lang.String[] communityPermissions,
269                    java.lang.String[] guestPermissions)
270                    throws com.liferay.portal.kernel.exception.PortalException,
271                            com.liferay.portal.kernel.exception.SystemException {
272                    getService()
273                            .addFileShortcutResources(fileShortcut, communityPermissions,
274                            guestPermissions);
275            }
276    
277            public static void addFileShortcutResources(long fileShortcutId,
278                    boolean addCommunityPermissions, boolean addGuestPermissions)
279                    throws com.liferay.portal.kernel.exception.PortalException,
280                            com.liferay.portal.kernel.exception.SystemException {
281                    getService()
282                            .addFileShortcutResources(fileShortcutId, addCommunityPermissions,
283                            addGuestPermissions);
284            }
285    
286            public static void addFileShortcutResources(long fileShortcutId,
287                    java.lang.String[] communityPermissions,
288                    java.lang.String[] guestPermissions)
289                    throws com.liferay.portal.kernel.exception.PortalException,
290                            com.liferay.portal.kernel.exception.SystemException {
291                    getService()
292                            .addFileShortcutResources(fileShortcutId, communityPermissions,
293                            guestPermissions);
294            }
295    
296            public static void deleteFileShortcut(
297                    com.liferay.portlet.documentlibrary.model.DLFileShortcut fileShortcut)
298                    throws com.liferay.portal.kernel.exception.PortalException,
299                            com.liferay.portal.kernel.exception.SystemException {
300                    getService().deleteFileShortcut(fileShortcut);
301            }
302    
303            public static void deleteFileShortcut(long fileShortcutId)
304                    throws com.liferay.portal.kernel.exception.PortalException,
305                            com.liferay.portal.kernel.exception.SystemException {
306                    getService().deleteFileShortcut(fileShortcutId);
307            }
308    
309            public static void deleteFileShortcuts(long groupId, long toFolderId,
310                    java.lang.String toName)
311                    throws com.liferay.portal.kernel.exception.PortalException,
312                            com.liferay.portal.kernel.exception.SystemException {
313                    getService().deleteFileShortcuts(groupId, toFolderId, toName);
314            }
315    
316            public static com.liferay.portlet.documentlibrary.model.DLFileShortcut getFileShortcut(
317                    long fileShortcutId)
318                    throws com.liferay.portal.kernel.exception.PortalException,
319                            com.liferay.portal.kernel.exception.SystemException {
320                    return getService().getFileShortcut(fileShortcutId);
321            }
322    
323            public static void updateAsset(long userId,
324                    com.liferay.portlet.documentlibrary.model.DLFileShortcut fileShortcut,
325                    long[] assetCategoryIds, java.lang.String[] assetTagNames)
326                    throws com.liferay.portal.kernel.exception.PortalException,
327                            com.liferay.portal.kernel.exception.SystemException {
328                    getService()
329                            .updateAsset(userId, fileShortcut, assetCategoryIds, assetTagNames);
330            }
331    
332            public static com.liferay.portlet.documentlibrary.model.DLFileShortcut updateFileShortcut(
333                    long userId, long fileShortcutId, long folderId, long toFolderId,
334                    java.lang.String toName,
335                    com.liferay.portal.service.ServiceContext serviceContext)
336                    throws com.liferay.portal.kernel.exception.PortalException,
337                            com.liferay.portal.kernel.exception.SystemException {
338                    return getService()
339                                       .updateFileShortcut(userId, fileShortcutId, folderId,
340                            toFolderId, toName, serviceContext);
341            }
342    
343            public static void updateFileShortcuts(long groupId, long oldToFolderId,
344                    java.lang.String oldToName, long newToFolderId,
345                    java.lang.String newToName)
346                    throws com.liferay.portal.kernel.exception.SystemException {
347                    getService()
348                            .updateFileShortcuts(groupId, oldToFolderId, oldToName,
349                            newToFolderId, newToName);
350            }
351    
352            public static DLFileShortcutLocalService getService() {
353                    if (_service == null) {
354                            _service = (DLFileShortcutLocalService)PortalBeanLocatorUtil.locate(DLFileShortcutLocalService.class.getName());
355                    }
356    
357                    return _service;
358            }
359    
360            public void setService(DLFileShortcutLocalService service) {
361                    _service = service;
362            }
363    
364            private static DLFileShortcutLocalService _service;
365    }