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     * Provides the remote service utility for DLFolder. This utility wraps
022     * {@link com.liferay.portlet.documentlibrary.service.impl.DLFolderServiceImpl} and is the
023     * primary access point for service operations in application layer code running
024     * on a remote server. Methods of this service are expected to have security
025     * checks based on the propagated JAAS credentials because this service can be
026     * accessed remotely.
027     *
028     * @author Brian Wing Shun Chan
029     * @see DLFolderService
030     * @see com.liferay.portlet.documentlibrary.service.base.DLFolderServiceBaseImpl
031     * @see com.liferay.portlet.documentlibrary.service.impl.DLFolderServiceImpl
032     * @generated
033     */
034    public class DLFolderServiceUtil {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.documentlibrary.service.impl.DLFolderServiceImpl} and rerun ServiceBuilder to regenerate this class.
039             */
040    
041            /**
042            * Returns the Spring bean ID for this bean.
043            *
044            * @return the Spring bean ID for this bean
045            */
046            public static java.lang.String getBeanIdentifier() {
047                    return getService().getBeanIdentifier();
048            }
049    
050            /**
051            * Sets the Spring bean ID for this bean.
052            *
053            * @param beanIdentifier the Spring bean ID for this bean
054            */
055            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
056                    getService().setBeanIdentifier(beanIdentifier);
057            }
058    
059            public static com.liferay.portlet.documentlibrary.model.DLFolder addFolder(
060                    long groupId, long repositoryId, boolean mountPoint,
061                    long parentFolderId, java.lang.String name,
062                    java.lang.String description,
063                    com.liferay.portal.service.ServiceContext serviceContext)
064                    throws com.liferay.portal.kernel.exception.PortalException,
065                            com.liferay.portal.kernel.exception.SystemException {
066                    return getService()
067                                       .addFolder(groupId, repositoryId, mountPoint,
068                            parentFolderId, name, description, serviceContext);
069            }
070    
071            public static void deleteFolder(long folderId)
072                    throws com.liferay.portal.kernel.exception.PortalException,
073                            com.liferay.portal.kernel.exception.SystemException {
074                    getService().deleteFolder(folderId);
075            }
076    
077            public static void deleteFolder(long folderId, boolean includeTrashedEntries)
078                    throws com.liferay.portal.kernel.exception.PortalException,
079                            com.liferay.portal.kernel.exception.SystemException {
080                    getService().deleteFolder(folderId, includeTrashedEntries);
081            }
082    
083            public static void deleteFolder(long groupId, long parentFolderId,
084                    java.lang.String name)
085                    throws com.liferay.portal.kernel.exception.PortalException,
086                            com.liferay.portal.kernel.exception.SystemException {
087                    getService().deleteFolder(groupId, parentFolderId, name);
088            }
089    
090            public static java.util.List<java.lang.Object> getFileEntriesAndFileShortcuts(
091                    long groupId, long folderId, int status, int start, int end)
092                    throws com.liferay.portal.kernel.exception.PortalException,
093                            com.liferay.portal.kernel.exception.SystemException {
094                    return getService()
095                                       .getFileEntriesAndFileShortcuts(groupId, folderId, status,
096                            start, end);
097            }
098    
099            public static int getFileEntriesAndFileShortcutsCount(long groupId,
100                    long folderId, int status)
101                    throws com.liferay.portal.kernel.exception.PortalException,
102                            com.liferay.portal.kernel.exception.SystemException {
103                    return getService()
104                                       .getFileEntriesAndFileShortcutsCount(groupId, folderId,
105                            status);
106            }
107    
108            public static int getFileEntriesAndFileShortcutsCount(long groupId,
109                    long folderId, int status, java.lang.String[] mimeTypes)
110                    throws com.liferay.portal.kernel.exception.PortalException,
111                            com.liferay.portal.kernel.exception.SystemException {
112                    return getService()
113                                       .getFileEntriesAndFileShortcutsCount(groupId, folderId,
114                            status, mimeTypes);
115            }
116    
117            public static com.liferay.portlet.documentlibrary.model.DLFolder getFolder(
118                    long folderId)
119                    throws com.liferay.portal.kernel.exception.PortalException,
120                            com.liferay.portal.kernel.exception.SystemException {
121                    return getService().getFolder(folderId);
122            }
123    
124            public static com.liferay.portlet.documentlibrary.model.DLFolder getFolder(
125                    long groupId, long parentFolderId, java.lang.String name)
126                    throws com.liferay.portal.kernel.exception.PortalException,
127                            com.liferay.portal.kernel.exception.SystemException {
128                    return getService().getFolder(groupId, parentFolderId, name);
129            }
130    
131            public static java.util.List<java.lang.Long> getFolderIds(long groupId,
132                    long folderId)
133                    throws com.liferay.portal.kernel.exception.PortalException,
134                            com.liferay.portal.kernel.exception.SystemException {
135                    return getService().getFolderIds(groupId, folderId);
136            }
137    
138            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
139                    long groupId, long parentFolderId, int status,
140                    boolean includeMountfolders, int start, int end,
141                    com.liferay.portal.kernel.util.OrderByComparator obc)
142                    throws com.liferay.portal.kernel.exception.PortalException,
143                            com.liferay.portal.kernel.exception.SystemException {
144                    return getService()
145                                       .getFolders(groupId, parentFolderId, status,
146                            includeMountfolders, start, end, obc);
147            }
148    
149            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
150                    long groupId, long parentFolderId, int start, int end,
151                    com.liferay.portal.kernel.util.OrderByComparator obc)
152                    throws com.liferay.portal.kernel.exception.PortalException,
153                            com.liferay.portal.kernel.exception.SystemException {
154                    return getService().getFolders(groupId, parentFolderId, start, end, obc);
155            }
156    
157            public static java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(
158                    long groupId, long folderId, int status, boolean includeMountFolders,
159                    int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
160                    throws com.liferay.portal.kernel.exception.PortalException,
161                            com.liferay.portal.kernel.exception.SystemException {
162                    return getService()
163                                       .getFoldersAndFileEntriesAndFileShortcuts(groupId, folderId,
164                            status, includeMountFolders, start, end, obc);
165            }
166    
167            public static java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(
168                    long groupId, long folderId, int status, java.lang.String[] mimeTypes,
169                    boolean includeMountFolders, int start, int end,
170                    com.liferay.portal.kernel.util.OrderByComparator obc)
171                    throws com.liferay.portal.kernel.exception.PortalException,
172                            com.liferay.portal.kernel.exception.SystemException {
173                    return getService()
174                                       .getFoldersAndFileEntriesAndFileShortcuts(groupId, folderId,
175                            status, mimeTypes, includeMountFolders, start, end, obc);
176            }
177    
178            public static int getFoldersAndFileEntriesAndFileShortcutsCount(
179                    long groupId, long folderId, int status, boolean includeMountFolders)
180                    throws com.liferay.portal.kernel.exception.PortalException,
181                            com.liferay.portal.kernel.exception.SystemException {
182                    return getService()
183                                       .getFoldersAndFileEntriesAndFileShortcutsCount(groupId,
184                            folderId, status, includeMountFolders);
185            }
186    
187            public static int getFoldersAndFileEntriesAndFileShortcutsCount(
188                    long groupId, long folderId, int status, java.lang.String[] mimeTypes,
189                    boolean includeMountFolders)
190                    throws com.liferay.portal.kernel.exception.PortalException,
191                            com.liferay.portal.kernel.exception.SystemException {
192                    return getService()
193                                       .getFoldersAndFileEntriesAndFileShortcutsCount(groupId,
194                            folderId, status, mimeTypes, includeMountFolders);
195            }
196    
197            public static int getFoldersCount(long groupId, long parentFolderId)
198                    throws com.liferay.portal.kernel.exception.PortalException,
199                            com.liferay.portal.kernel.exception.SystemException {
200                    return getService().getFoldersCount(groupId, parentFolderId);
201            }
202    
203            public static int getFoldersCount(long groupId, long parentFolderId,
204                    int status, boolean includeMountfolders)
205                    throws com.liferay.portal.kernel.exception.PortalException,
206                            com.liferay.portal.kernel.exception.SystemException {
207                    return getService()
208                                       .getFoldersCount(groupId, parentFolderId, status,
209                            includeMountfolders);
210            }
211    
212            public static java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getMountFolders(
213                    long groupId, long parentFolderId, int start, int end,
214                    com.liferay.portal.kernel.util.OrderByComparator obc)
215                    throws com.liferay.portal.kernel.exception.PortalException,
216                            com.liferay.portal.kernel.exception.SystemException {
217                    return getService()
218                                       .getMountFolders(groupId, parentFolderId, start, end, obc);
219            }
220    
221            public static int getMountFoldersCount(long groupId, long parentFolderId)
222                    throws com.liferay.portal.kernel.exception.PortalException,
223                            com.liferay.portal.kernel.exception.SystemException {
224                    return getService().getMountFoldersCount(groupId, parentFolderId);
225            }
226    
227            public static void getSubfolderIds(
228                    java.util.List<java.lang.Long> folderIds, long groupId, long folderId)
229                    throws com.liferay.portal.kernel.exception.PortalException,
230                            com.liferay.portal.kernel.exception.SystemException {
231                    getService().getSubfolderIds(folderIds, groupId, folderId);
232            }
233    
234            public static java.util.List<java.lang.Long> getSubfolderIds(long groupId,
235                    long folderId, boolean recurse)
236                    throws com.liferay.portal.kernel.exception.PortalException,
237                            com.liferay.portal.kernel.exception.SystemException {
238                    return getService().getSubfolderIds(groupId, folderId, recurse);
239            }
240    
241            public static boolean hasFolderLock(long folderId)
242                    throws com.liferay.portal.kernel.exception.PortalException,
243                            com.liferay.portal.kernel.exception.SystemException {
244                    return getService().hasFolderLock(folderId);
245            }
246    
247            public static boolean hasInheritableLock(long folderId)
248                    throws com.liferay.portal.kernel.exception.PortalException,
249                            com.liferay.portal.kernel.exception.SystemException {
250                    return getService().hasInheritableLock(folderId);
251            }
252    
253            public static boolean isFolderLocked(long folderId)
254                    throws com.liferay.portal.kernel.exception.SystemException {
255                    return getService().isFolderLocked(folderId);
256            }
257    
258            public static com.liferay.portal.model.Lock lockFolder(long folderId)
259                    throws com.liferay.portal.kernel.exception.PortalException,
260                            com.liferay.portal.kernel.exception.SystemException {
261                    return getService().lockFolder(folderId);
262            }
263    
264            public static com.liferay.portal.model.Lock lockFolder(long folderId,
265                    java.lang.String owner, boolean inheritable, long expirationTime)
266                    throws com.liferay.portal.kernel.exception.PortalException,
267                            com.liferay.portal.kernel.exception.SystemException {
268                    return getService()
269                                       .lockFolder(folderId, owner, inheritable, expirationTime);
270            }
271    
272            public static com.liferay.portlet.documentlibrary.model.DLFolder moveFolder(
273                    long folderId, long parentFolderId,
274                    com.liferay.portal.service.ServiceContext serviceContext)
275                    throws com.liferay.portal.kernel.exception.PortalException,
276                            com.liferay.portal.kernel.exception.SystemException {
277                    return getService().moveFolder(folderId, parentFolderId, serviceContext);
278            }
279    
280            public static com.liferay.portal.model.Lock refreshFolderLock(
281                    java.lang.String lockUuid, long companyId, long expirationTime)
282                    throws com.liferay.portal.kernel.exception.PortalException,
283                            com.liferay.portal.kernel.exception.SystemException {
284                    return getService()
285                                       .refreshFolderLock(lockUuid, companyId, expirationTime);
286            }
287    
288            public static void unlockFolder(long groupId, long parentFolderId,
289                    java.lang.String name, java.lang.String lockUuid)
290                    throws com.liferay.portal.kernel.exception.PortalException,
291                            com.liferay.portal.kernel.exception.SystemException {
292                    getService().unlockFolder(groupId, parentFolderId, name, lockUuid);
293            }
294    
295            public static void unlockFolder(long folderId, java.lang.String lockUuid)
296                    throws com.liferay.portal.kernel.exception.PortalException,
297                            com.liferay.portal.kernel.exception.SystemException {
298                    getService().unlockFolder(folderId, lockUuid);
299            }
300    
301            public static com.liferay.portlet.documentlibrary.model.DLFolder updateFolder(
302                    long folderId, java.lang.String name, java.lang.String description,
303                    long defaultFileEntryTypeId,
304                    java.util.List<java.lang.Long> fileEntryTypeIds,
305                    boolean overrideFileEntryTypes,
306                    com.liferay.portal.service.ServiceContext serviceContext)
307                    throws com.liferay.portal.kernel.exception.PortalException,
308                            com.liferay.portal.kernel.exception.SystemException {
309                    return getService()
310                                       .updateFolder(folderId, name, description,
311                            defaultFileEntryTypeId, fileEntryTypeIds, overrideFileEntryTypes,
312                            serviceContext);
313            }
314    
315            public static boolean verifyInheritableLock(long folderId,
316                    java.lang.String lockUuid)
317                    throws com.liferay.portal.kernel.exception.PortalException,
318                            com.liferay.portal.kernel.exception.SystemException {
319                    return getService().verifyInheritableLock(folderId, lockUuid);
320            }
321    
322            public static DLFolderService getService() {
323                    if (_service == null) {
324                            _service = (DLFolderService)PortalBeanLocatorUtil.locate(DLFolderService.class.getName());
325    
326                            ReferenceRegistry.registerReference(DLFolderServiceUtil.class,
327                                    "_service");
328                    }
329    
330                    return _service;
331            }
332    
333            /**
334             * @deprecated As of 6.2.0
335             */
336            public void setService(DLFolderService service) {
337            }
338    
339            private static DLFolderService _service;
340    }