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.MethodCache;
019    import com.liferay.portal.kernel.util.ReferenceRegistry;
020    
021    /**
022     * The utility for the document library 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 document library folder to the database. Also notifies the appropriate model listeners.
043            *
044            * @param dlFolder the document library folder
045            * @return the document library 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 document library folder with the primary key. Does not add the document library folder to the database.
056            *
057            * @param folderId the primary key for the new document library folder
058            * @return the new document library 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 document library folder with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param folderId the primary key of the document library folder
069            * @throws PortalException if a document library 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 document library folder from the database. Also notifies the appropriate model listeners.
080            *
081            * @param dlFolder the document library 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            public static com.liferay.portlet.documentlibrary.model.DLFolder fetchDLFolder(
162                    long folderId)
163                    throws com.liferay.portal.kernel.exception.SystemException {
164                    return getService().fetchDLFolder(folderId);
165            }
166    
167            /**
168            * Returns the document library folder with the primary key.
169            *
170            * @param folderId the primary key of the document library folder
171            * @return the document library folder
172            * @throws PortalException if a document library folder with the primary key could not be found
173            * @throws SystemException if a system exception occurred
174            */
175            public static com.liferay.portlet.documentlibrary.model.DLFolder getDLFolder(
176                    long folderId)
177                    throws com.liferay.portal.kernel.exception.PortalException,
178                            com.liferay.portal.kernel.exception.SystemException {
179                    return getService().getDLFolder(folderId);
180            }
181    
182            public static com.liferay.portal.model.PersistedModel getPersistedModel(
183                    java.io.Serializable primaryKeyObj)
184                    throws com.liferay.portal.kernel.exception.PortalException,
185                            com.liferay.portal.kernel.exception.SystemException {
186                    return getService().getPersistedModel(primaryKeyObj);
187            }
188    
189            /**
190            * Returns the document library folder with the UUID in the group.
191            *
192            * @param uuid the UUID of document library folder
193            * @param groupId the group id of the document library folder
194            * @return the document library folder
195            * @throws PortalException if a document library folder with the UUID in the group could not be found
196            * @throws SystemException if a system exception occurred
197            */
198            public static com.liferay.portlet.documentlibrary.model.DLFolder getDLFolderByUuidAndGroupId(
199                    java.lang.String uuid, long groupId)
200                    throws com.liferay.portal.kernel.exception.PortalException,
201                            com.liferay.portal.kernel.exception.SystemException {
202                    return getService().getDLFolderByUuidAndGroupId(uuid, groupId);
203            }
204    
205            /**
206            * Returns a range of all the document library folders.
207            *
208            * <p>
209            * 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.
210            * </p>
211            *
212            * @param start the lower bound of the range of document library folders
213            * @param end the upper bound of the range of document library folders (not inclusive)
214            * @return the range of document library folders
215            * @throws SystemException if a system exception occurred
216            */
217            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getDLFolders(
218                    int start, int end)
219                    throws com.liferay.portal.kernel.exception.SystemException {
220                    return getService().getDLFolders(start, end);
221            }
222    
223            /**
224            * Returns the number of document library folders.
225            *
226            * @return the number of document library folders
227            * @throws SystemException if a system exception occurred
228            */
229            public static int getDLFoldersCount()
230                    throws com.liferay.portal.kernel.exception.SystemException {
231                    return getService().getDLFoldersCount();
232            }
233    
234            /**
235            * Updates the document library folder in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
236            *
237            * @param dlFolder the document library folder
238            * @return the document library folder that was updated
239            * @throws SystemException if a system exception occurred
240            */
241            public static com.liferay.portlet.documentlibrary.model.DLFolder updateDLFolder(
242                    com.liferay.portlet.documentlibrary.model.DLFolder dlFolder)
243                    throws com.liferay.portal.kernel.exception.SystemException {
244                    return getService().updateDLFolder(dlFolder);
245            }
246    
247            /**
248            * Updates the document library folder in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
249            *
250            * @param dlFolder the document library folder
251            * @param merge whether to merge the document library 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.
252            * @return the document library folder that was updated
253            * @throws SystemException if a system exception occurred
254            */
255            public static com.liferay.portlet.documentlibrary.model.DLFolder updateDLFolder(
256                    com.liferay.portlet.documentlibrary.model.DLFolder dlFolder,
257                    boolean merge)
258                    throws com.liferay.portal.kernel.exception.SystemException {
259                    return getService().updateDLFolder(dlFolder, merge);
260            }
261    
262            /**
263            * Returns the Spring bean ID for this bean.
264            *
265            * @return the Spring bean ID for this bean
266            */
267            public static java.lang.String getBeanIdentifier() {
268                    return getService().getBeanIdentifier();
269            }
270    
271            /**
272            * Sets the Spring bean ID for this bean.
273            *
274            * @param beanIdentifier the Spring bean ID for this bean
275            */
276            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
277                    getService().setBeanIdentifier(beanIdentifier);
278            }
279    
280            public static com.liferay.portlet.documentlibrary.model.DLFolder addFolder(
281                    long userId, long groupId, long repositoryId, boolean mountPoint,
282                    long parentFolderId, java.lang.String name,
283                    java.lang.String description,
284                    com.liferay.portal.service.ServiceContext serviceContext)
285                    throws com.liferay.portal.kernel.exception.PortalException,
286                            com.liferay.portal.kernel.exception.SystemException {
287                    return getService()
288                                       .addFolder(userId, groupId, repositoryId, mountPoint,
289                            parentFolderId, name, description, serviceContext);
290            }
291    
292            public static void deleteAll(long groupId)
293                    throws com.liferay.portal.kernel.exception.PortalException,
294                            com.liferay.portal.kernel.exception.SystemException {
295                    getService().deleteAll(groupId);
296            }
297    
298            public static void deleteFolder(long folderId)
299                    throws com.liferay.portal.kernel.exception.PortalException,
300                            com.liferay.portal.kernel.exception.SystemException {
301                    getService().deleteFolder(folderId);
302            }
303    
304            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getCompanyFolders(
305                    long companyId, int start, int end)
306                    throws com.liferay.portal.kernel.exception.SystemException {
307                    return getService().getCompanyFolders(companyId, start, end);
308            }
309    
310            public static int getCompanyFoldersCount(long companyId)
311                    throws com.liferay.portal.kernel.exception.SystemException {
312                    return getService().getCompanyFoldersCount(companyId);
313            }
314    
315            public static java.util.List<java.lang.Object> getFileEntriesAndFileShortcuts(
316                    long groupId, long folderId, int status, int start, int end)
317                    throws com.liferay.portal.kernel.exception.SystemException {
318                    return getService()
319                                       .getFileEntriesAndFileShortcuts(groupId, folderId, status,
320                            start, end);
321            }
322    
323            public static int getFileEntriesAndFileShortcutsCount(long groupId,
324                    long folderId, int status)
325                    throws com.liferay.portal.kernel.exception.SystemException {
326                    return getService()
327                                       .getFileEntriesAndFileShortcutsCount(groupId, folderId,
328                            status);
329            }
330    
331            public static com.liferay.portlet.documentlibrary.model.DLFolder getFolder(
332                    long folderId)
333                    throws com.liferay.portal.kernel.exception.PortalException,
334                            com.liferay.portal.kernel.exception.SystemException {
335                    return getService().getFolder(folderId);
336            }
337    
338            public static com.liferay.portlet.documentlibrary.model.DLFolder getFolder(
339                    long groupId, long parentFolderId, java.lang.String name)
340                    throws com.liferay.portal.kernel.exception.PortalException,
341                            com.liferay.portal.kernel.exception.SystemException {
342                    return getService().getFolder(groupId, parentFolderId, name);
343            }
344    
345            public static long getFolderId(long companyId, long folderId)
346                    throws com.liferay.portal.kernel.exception.SystemException {
347                    return getService().getFolderId(companyId, folderId);
348            }
349    
350            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
351                    long groupId, long parentFolderId)
352                    throws com.liferay.portal.kernel.exception.SystemException {
353                    return getService().getFolders(groupId, parentFolderId);
354            }
355    
356            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
357                    long groupId, long parentFolderId, boolean includeMountfolders)
358                    throws com.liferay.portal.kernel.exception.SystemException {
359                    return getService()
360                                       .getFolders(groupId, parentFolderId, includeMountfolders);
361            }
362    
363            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
364                    long groupId, long parentFolderId, boolean includeMountfolders,
365                    int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
366                    throws com.liferay.portal.kernel.exception.SystemException {
367                    return getService()
368                                       .getFolders(groupId, parentFolderId, includeMountfolders,
369                            start, end, obc);
370            }
371    
372            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
373                    long groupId, long parentFolderId, int start, int end,
374                    com.liferay.portal.kernel.util.OrderByComparator obc)
375                    throws com.liferay.portal.kernel.exception.SystemException {
376                    return getService().getFolders(groupId, parentFolderId, start, end, obc);
377            }
378    
379            public static java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(
380                    long groupId, long folderId, int status, boolean includeMountFolders,
381                    int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
382                    throws com.liferay.portal.kernel.exception.SystemException {
383                    return getService()
384                                       .getFoldersAndFileEntriesAndFileShortcuts(groupId, folderId,
385                            status, includeMountFolders, start, end, obc);
386            }
387    
388            public static java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(
389                    long groupId, long folderId, int status, java.lang.String[] mimeTypes,
390                    boolean includeMountFolders, int start, int end,
391                    com.liferay.portal.kernel.util.OrderByComparator obc)
392                    throws com.liferay.portal.kernel.exception.SystemException {
393                    return getService()
394                                       .getFoldersAndFileEntriesAndFileShortcuts(groupId, folderId,
395                            status, mimeTypes, includeMountFolders, start, end, obc);
396            }
397    
398            public static int getFoldersAndFileEntriesAndFileShortcutsCount(
399                    long groupId, long folderId, int status, boolean includeMountFolders)
400                    throws com.liferay.portal.kernel.exception.SystemException {
401                    return getService()
402                                       .getFoldersAndFileEntriesAndFileShortcutsCount(groupId,
403                            folderId, status, includeMountFolders);
404            }
405    
406            public static int getFoldersAndFileEntriesAndFileShortcutsCount(
407                    long groupId, long folderId, int status, java.lang.String[] mimeTypes,
408                    boolean includeMountFolders)
409                    throws com.liferay.portal.kernel.exception.SystemException {
410                    return getService()
411                                       .getFoldersAndFileEntriesAndFileShortcutsCount(groupId,
412                            folderId, status, mimeTypes, includeMountFolders);
413            }
414    
415            public static int getFoldersCount(long groupId, long parentFolderId)
416                    throws com.liferay.portal.kernel.exception.SystemException {
417                    return getService().getFoldersCount(groupId, parentFolderId);
418            }
419    
420            public static int getFoldersCount(long groupId, long parentFolderId,
421                    boolean includeMountfolders)
422                    throws com.liferay.portal.kernel.exception.SystemException {
423                    return getService()
424                                       .getFoldersCount(groupId, parentFolderId, includeMountfolders);
425            }
426    
427            public static int getFoldersFileEntriesCount(long groupId,
428                    java.util.List<java.lang.Long> folderIds, int status)
429                    throws com.liferay.portal.kernel.exception.SystemException {
430                    return getService()
431                                       .getFoldersFileEntriesCount(groupId, folderIds, status);
432            }
433    
434            public static com.liferay.portlet.documentlibrary.model.DLFolder getMountFolder(
435                    long repositoryId)
436                    throws com.liferay.portal.kernel.exception.PortalException,
437                            com.liferay.portal.kernel.exception.SystemException {
438                    return getService().getMountFolder(repositoryId);
439            }
440    
441            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getMountFolders(
442                    long groupId, long parentFolderId, int start, int end,
443                    com.liferay.portal.kernel.util.OrderByComparator obc)
444                    throws com.liferay.portal.kernel.exception.SystemException {
445                    return getService()
446                                       .getMountFolders(groupId, parentFolderId, start, end, obc);
447            }
448    
449            public static int getMountFoldersCount(long groupId, long parentFolderId)
450                    throws com.liferay.portal.kernel.exception.SystemException {
451                    return getService().getMountFoldersCount(groupId, parentFolderId);
452            }
453    
454            public static void getSubfolderIds(
455                    java.util.List<java.lang.Long> folderIds, long groupId, long folderId)
456                    throws com.liferay.portal.kernel.exception.SystemException {
457                    getService().getSubfolderIds(folderIds, groupId, folderId);
458            }
459    
460            public static com.liferay.portlet.documentlibrary.model.DLFolder moveFolder(
461                    long folderId, long parentFolderId,
462                    com.liferay.portal.service.ServiceContext serviceContext)
463                    throws com.liferay.portal.kernel.exception.PortalException,
464                            com.liferay.portal.kernel.exception.SystemException {
465                    return getService().moveFolder(folderId, parentFolderId, serviceContext);
466            }
467    
468            public static com.liferay.portlet.documentlibrary.model.DLFolder updateFolder(
469                    long folderId, long parentFolderId, java.lang.String name,
470                    java.lang.String description, long defaultFileEntryTypeId,
471                    java.util.List<java.lang.Long> fileEntryTypeIds,
472                    boolean overrideFileEntryTypes,
473                    com.liferay.portal.service.ServiceContext serviceContext)
474                    throws com.liferay.portal.kernel.exception.PortalException,
475                            com.liferay.portal.kernel.exception.SystemException {
476                    return getService()
477                                       .updateFolder(folderId, parentFolderId, name, description,
478                            defaultFileEntryTypeId, fileEntryTypeIds, overrideFileEntryTypes,
479                            serviceContext);
480            }
481    
482            public static com.liferay.portlet.documentlibrary.model.DLFolder updateFolder(
483                    long folderId, java.lang.String name, java.lang.String description,
484                    long defaultFileEntryTypeId,
485                    java.util.List<java.lang.Long> fileEntryTypeIds,
486                    boolean overrideFileEntryTypes,
487                    com.liferay.portal.service.ServiceContext serviceContext)
488                    throws com.liferay.portal.kernel.exception.PortalException,
489                            com.liferay.portal.kernel.exception.SystemException {
490                    return getService()
491                                       .updateFolder(folderId, name, description,
492                            defaultFileEntryTypeId, fileEntryTypeIds, overrideFileEntryTypes,
493                            serviceContext);
494            }
495    
496            public static com.liferay.portlet.documentlibrary.model.DLFolder updateFolderAndFileEntryTypes(
497                    long folderId, long parentFolderId, java.lang.String name,
498                    java.lang.String description, long defaultFileEntryTypeId,
499                    java.util.List<java.lang.Long> fileEntryTypeIds,
500                    boolean overrideFileEntryTypes,
501                    com.liferay.portal.service.ServiceContext serviceContext)
502                    throws com.liferay.portal.kernel.exception.PortalException,
503                            com.liferay.portal.kernel.exception.SystemException {
504                    return getService()
505                                       .updateFolderAndFileEntryTypes(folderId, parentFolderId,
506                            name, description, defaultFileEntryTypeId, fileEntryTypeIds,
507                            overrideFileEntryTypes, serviceContext);
508            }
509    
510            public static void updateLastPostDate(long folderId,
511                    java.util.Date lastPostDate)
512                    throws com.liferay.portal.kernel.exception.PortalException,
513                            com.liferay.portal.kernel.exception.SystemException {
514                    getService().updateLastPostDate(folderId, lastPostDate);
515            }
516    
517            public static DLFolderLocalService getService() {
518                    if (_service == null) {
519                            _service = (DLFolderLocalService)PortalBeanLocatorUtil.locate(DLFolderLocalService.class.getName());
520    
521                            ReferenceRegistry.registerReference(DLFolderLocalServiceUtil.class,
522                                    "_service");
523                            MethodCache.remove(DLFolderLocalService.class);
524                    }
525    
526                    return _service;
527            }
528    
529            public void setService(DLFolderLocalService service) {
530                    MethodCache.remove(DLFolderLocalService.class);
531    
532                    _service = service;
533    
534                    ReferenceRegistry.registerReference(DLFolderLocalServiceUtil.class,
535                            "_service");
536                    MethodCache.remove(DLFolderLocalService.class);
537            }
538    
539            private static DLFolderLocalService _service;
540    }