001    /**
002     * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
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 d l folder local service. This utility wraps {@link com.liferay.portlet.documentlibrary.service.impl.DLFolderLocalServiceImpl} 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 DLFolderLocalService
030     * @see com.liferay.portlet.documentlibrary.service.base.DLFolderLocalServiceBaseImpl
031     * @see com.liferay.portlet.documentlibrary.service.impl.DLFolderLocalServiceImpl
032     * @generated
033     */
034    public class DLFolderLocalServiceUtil {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.documentlibrary.service.impl.DLFolderLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
039             */
040    
041            /**
042            * Adds the d l folder to the database. Also notifies the appropriate model listeners.
043            *
044            * @param dlFolder the d l folder
045            * @return the d l folder that was added
046            * @throws SystemException if a system exception occurred
047            */
048            public static com.liferay.portlet.documentlibrary.model.DLFolder addDLFolder(
049                    com.liferay.portlet.documentlibrary.model.DLFolder dlFolder)
050                    throws com.liferay.portal.kernel.exception.SystemException {
051                    return getService().addDLFolder(dlFolder);
052            }
053    
054            /**
055            * Creates a new d l folder with the primary key. Does not add the d l folder to the database.
056            *
057            * @param folderId the primary key for the new d l folder
058            * @return the new d l folder
059            */
060            public static com.liferay.portlet.documentlibrary.model.DLFolder createDLFolder(
061                    long folderId) {
062                    return getService().createDLFolder(folderId);
063            }
064    
065            /**
066            * Deletes the d l folder with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param folderId the primary key of the d l folder
069            * @throws PortalException if a d l folder with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static void deleteDLFolder(long folderId)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException {
075                    getService().deleteDLFolder(folderId);
076            }
077    
078            /**
079            * Deletes the d l folder from the database. Also notifies the appropriate model listeners.
080            *
081            * @param dlFolder the d l folder
082            * @throws SystemException if a system exception occurred
083            */
084            public static void deleteDLFolder(
085                    com.liferay.portlet.documentlibrary.model.DLFolder dlFolder)
086                    throws com.liferay.portal.kernel.exception.SystemException {
087                    getService().deleteDLFolder(dlFolder);
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 d l folder with the primary key.
163            *
164            * @param folderId the primary key of the d l folder
165            * @return the d l folder
166            * @throws PortalException if a d l folder 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.DLFolder getDLFolder(
170                    long folderId)
171                    throws com.liferay.portal.kernel.exception.PortalException,
172                            com.liferay.portal.kernel.exception.SystemException {
173                    return getService().getDLFolder(folderId);
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 d l folder with the UUID in the group.
185            *
186            * @param uuid the UUID of d l folder
187            * @param groupId the group id of the d l folder
188            * @return the d l folder
189            * @throws PortalException if a d l folder 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.DLFolder getDLFolderByUuidAndGroupId(
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().getDLFolderByUuidAndGroupId(uuid, groupId);
197            }
198    
199            /**
200            * Returns a range of all the d l folders.
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 d l folders
207            * @param end the upper bound of the range of d l folders (not inclusive)
208            * @return the range of d l folders
209            * @throws SystemException if a system exception occurred
210            */
211            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getDLFolders(
212                    int start, int end)
213                    throws com.liferay.portal.kernel.exception.SystemException {
214                    return getService().getDLFolders(start, end);
215            }
216    
217            /**
218            * Returns the number of d l folders.
219            *
220            * @return the number of d l folders
221            * @throws SystemException if a system exception occurred
222            */
223            public static int getDLFoldersCount()
224                    throws com.liferay.portal.kernel.exception.SystemException {
225                    return getService().getDLFoldersCount();
226            }
227    
228            /**
229            * Updates the d l folder in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
230            *
231            * @param dlFolder the d l folder
232            * @return the d l folder that was updated
233            * @throws SystemException if a system exception occurred
234            */
235            public static com.liferay.portlet.documentlibrary.model.DLFolder updateDLFolder(
236                    com.liferay.portlet.documentlibrary.model.DLFolder dlFolder)
237                    throws com.liferay.portal.kernel.exception.SystemException {
238                    return getService().updateDLFolder(dlFolder);
239            }
240    
241            /**
242            * Updates the d l folder in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
243            *
244            * @param dlFolder the d l folder
245            * @param merge whether to merge the d l folder 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 d l folder that was updated
247            * @throws SystemException if a system exception occurred
248            */
249            public static com.liferay.portlet.documentlibrary.model.DLFolder updateDLFolder(
250                    com.liferay.portlet.documentlibrary.model.DLFolder dlFolder,
251                    boolean merge)
252                    throws com.liferay.portal.kernel.exception.SystemException {
253                    return getService().updateDLFolder(dlFolder, 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.DLFolder addFolder(
275                    long userId, long groupId, long parentFolderId, java.lang.String name,
276                    java.lang.String description,
277                    com.liferay.portal.service.ServiceContext serviceContext)
278                    throws com.liferay.portal.kernel.exception.PortalException,
279                            com.liferay.portal.kernel.exception.SystemException {
280                    return getService()
281                                       .addFolder(userId, groupId, parentFolderId, name,
282                            description, serviceContext);
283            }
284    
285            public static void addFolderResources(
286                    com.liferay.portlet.documentlibrary.model.DLFolder folder,
287                    boolean addCommunityPermissions, boolean addGuestPermissions)
288                    throws com.liferay.portal.kernel.exception.PortalException,
289                            com.liferay.portal.kernel.exception.SystemException {
290                    getService()
291                            .addFolderResources(folder, addCommunityPermissions,
292                            addGuestPermissions);
293            }
294    
295            public static void addFolderResources(
296                    com.liferay.portlet.documentlibrary.model.DLFolder folder,
297                    java.lang.String[] communityPermissions,
298                    java.lang.String[] guestPermissions)
299                    throws com.liferay.portal.kernel.exception.PortalException,
300                            com.liferay.portal.kernel.exception.SystemException {
301                    getService()
302                            .addFolderResources(folder, communityPermissions, guestPermissions);
303            }
304    
305            public static void addFolderResources(long folderId,
306                    boolean addCommunityPermissions, boolean addGuestPermissions)
307                    throws com.liferay.portal.kernel.exception.PortalException,
308                            com.liferay.portal.kernel.exception.SystemException {
309                    getService()
310                            .addFolderResources(folderId, addCommunityPermissions,
311                            addGuestPermissions);
312            }
313    
314            public static void addFolderResources(long folderId,
315                    java.lang.String[] communityPermissions,
316                    java.lang.String[] guestPermissions)
317                    throws com.liferay.portal.kernel.exception.PortalException,
318                            com.liferay.portal.kernel.exception.SystemException {
319                    getService()
320                            .addFolderResources(folderId, communityPermissions, guestPermissions);
321            }
322    
323            public static void deleteFolder(
324                    com.liferay.portlet.documentlibrary.model.DLFolder folder)
325                    throws com.liferay.portal.kernel.exception.PortalException,
326                            com.liferay.portal.kernel.exception.SystemException {
327                    getService().deleteFolder(folder);
328            }
329    
330            public static void deleteFolder(long folderId)
331                    throws com.liferay.portal.kernel.exception.PortalException,
332                            com.liferay.portal.kernel.exception.SystemException {
333                    getService().deleteFolder(folderId);
334            }
335    
336            public static void deleteFolders(long groupId)
337                    throws com.liferay.portal.kernel.exception.PortalException,
338                            com.liferay.portal.kernel.exception.SystemException {
339                    getService().deleteFolders(groupId);
340            }
341    
342            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getCompanyFolders(
343                    long companyId, int start, int end)
344                    throws com.liferay.portal.kernel.exception.SystemException {
345                    return getService().getCompanyFolders(companyId, start, end);
346            }
347    
348            public static int getCompanyFoldersCount(long companyId)
349                    throws com.liferay.portal.kernel.exception.SystemException {
350                    return getService().getCompanyFoldersCount(companyId);
351            }
352    
353            public static java.util.List<java.lang.Object> getFileEntriesAndFileShortcuts(
354                    long groupId, java.util.List<java.lang.Long> folderIds, int status,
355                    int start, int end)
356                    throws com.liferay.portal.kernel.exception.SystemException {
357                    return getService()
358                                       .getFileEntriesAndFileShortcuts(groupId, folderIds, status,
359                            start, end);
360            }
361    
362            public static java.util.List<java.lang.Object> getFileEntriesAndFileShortcuts(
363                    long groupId, long folderId, int status, int start, int end)
364                    throws com.liferay.portal.kernel.exception.SystemException {
365                    return getService()
366                                       .getFileEntriesAndFileShortcuts(groupId, folderId, status,
367                            start, end);
368            }
369    
370            public static int getFileEntriesAndFileShortcutsCount(long groupId,
371                    java.util.List<java.lang.Long> folderIds, int status)
372                    throws com.liferay.portal.kernel.exception.SystemException {
373                    return getService()
374                                       .getFileEntriesAndFileShortcutsCount(groupId, folderIds,
375                            status);
376            }
377    
378            public static int getFileEntriesAndFileShortcutsCount(long groupId,
379                    long folderId, int status)
380                    throws com.liferay.portal.kernel.exception.SystemException {
381                    return getService()
382                                       .getFileEntriesAndFileShortcutsCount(groupId, folderId,
383                            status);
384            }
385    
386            public static com.liferay.portlet.documentlibrary.model.DLFolder getFolder(
387                    long folderId)
388                    throws com.liferay.portal.kernel.exception.PortalException,
389                            com.liferay.portal.kernel.exception.SystemException {
390                    return getService().getFolder(folderId);
391            }
392    
393            public static com.liferay.portlet.documentlibrary.model.DLFolder getFolder(
394                    long groupId, long parentFolderId, java.lang.String name)
395                    throws com.liferay.portal.kernel.exception.PortalException,
396                            com.liferay.portal.kernel.exception.SystemException {
397                    return getService().getFolder(groupId, parentFolderId, name);
398            }
399    
400            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
401                    long companyId)
402                    throws com.liferay.portal.kernel.exception.SystemException {
403                    return getService().getFolders(companyId);
404            }
405    
406            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
407                    long groupId, long parentFolderId)
408                    throws com.liferay.portal.kernel.exception.SystemException {
409                    return getService().getFolders(groupId, parentFolderId);
410            }
411    
412            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
413                    long groupId, long parentFolderId, int start, int end)
414                    throws com.liferay.portal.kernel.exception.SystemException {
415                    return getService().getFolders(groupId, parentFolderId, start, end);
416            }
417    
418            public static java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(
419                    long groupId, java.util.List<java.lang.Long> folderIds, int status,
420                    int start, int end)
421                    throws com.liferay.portal.kernel.exception.SystemException {
422                    return getService()
423                                       .getFoldersAndFileEntriesAndFileShortcuts(groupId,
424                            folderIds, status, start, end);
425            }
426    
427            public static java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(
428                    long groupId, long folderId, int status, int start, int end)
429                    throws com.liferay.portal.kernel.exception.SystemException {
430                    return getService()
431                                       .getFoldersAndFileEntriesAndFileShortcuts(groupId, folderId,
432                            status, start, end);
433            }
434    
435            public static int getFoldersAndFileEntriesAndFileShortcutsCount(
436                    long groupId, java.util.List<java.lang.Long> folderIds, int status)
437                    throws com.liferay.portal.kernel.exception.SystemException {
438                    return getService()
439                                       .getFoldersAndFileEntriesAndFileShortcutsCount(groupId,
440                            folderIds, status);
441            }
442    
443            public static int getFoldersAndFileEntriesAndFileShortcutsCount(
444                    long groupId, long folderId, int status)
445                    throws com.liferay.portal.kernel.exception.SystemException {
446                    return getService()
447                                       .getFoldersAndFileEntriesAndFileShortcutsCount(groupId,
448                            folderId, status);
449            }
450    
451            public static int getFoldersCount(long groupId, long parentFolderId)
452                    throws com.liferay.portal.kernel.exception.SystemException {
453                    return getService().getFoldersCount(groupId, parentFolderId);
454            }
455    
456            public static void getSubfolderIds(
457                    java.util.List<java.lang.Long> folderIds, long groupId, long folderId)
458                    throws com.liferay.portal.kernel.exception.SystemException {
459                    getService().getSubfolderIds(folderIds, groupId, folderId);
460            }
461    
462            public static com.liferay.portlet.documentlibrary.model.DLFolder updateFolder(
463                    long folderId, long parentFolderId, java.lang.String name,
464                    java.lang.String description,
465                    com.liferay.portal.service.ServiceContext serviceContext)
466                    throws com.liferay.portal.kernel.exception.PortalException,
467                            com.liferay.portal.kernel.exception.SystemException {
468                    return getService()
469                                       .updateFolder(folderId, parentFolderId, name, description,
470                            serviceContext);
471            }
472    
473            public static DLFolderLocalService getService() {
474                    if (_service == null) {
475                            _service = (DLFolderLocalService)PortalBeanLocatorUtil.locate(DLFolderLocalService.class.getName());
476    
477                            ReferenceRegistry.registerReference(DLFolderLocalServiceUtil.class,
478                                    "_service");
479                            MethodCache.remove(DLFolderLocalService.class);
480                    }
481    
482                    return _service;
483            }
484    
485            public void setService(DLFolderLocalService service) {
486                    MethodCache.remove(DLFolderLocalService.class);
487    
488                    _service = service;
489    
490                    ReferenceRegistry.registerReference(DLFolderLocalServiceUtil.class,
491                            "_service");
492                    MethodCache.remove(DLFolderLocalService.class);
493            }
494    
495            private static DLFolderLocalService _service;
496    }