Class DLFolderServiceUtil
Object
com.liferay.document.library.kernel.service.DLFolderServiceUtil
Provides the remote service utility for DLFolder. This utility wraps
com.liferay.portlet.documentlibrary.service.impl.DLFolderServiceImpl
and is an
access point for service operations in application layer code running on a
remote server. Methods of this service are expected to have security checks
based on the propagated JAAS credentials because this service can be
accessed remotely.- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic DLFolder
addFolder
(String externalReferenceCode, long groupId, long repositoryId, boolean mountPoint, long parentFolderId, String name, String description, ServiceContext serviceContext) static void
deleteFolder
(long folderId) static void
deleteFolder
(long folderId, boolean includeTrashedEntries) static void
deleteFolder
(long groupId, long parentFolderId, String name) static DLFolder
getDLFolderByExternalReferenceCode
(String externalReferenceCode, long groupId) getFileEntriesAndFileShortcuts
(long groupId, long folderId, int status, int start, int end) static int
getFileEntriesAndFileShortcutsCount
(long groupId, long folderId, int status) static int
getFileEntriesAndFileShortcutsCount
(long groupId, long folderId, String[] mimeTypes, int status) static DLFolder
getFolder
(long folderId) static DLFolder
getFolderIds
(long groupId, long folderId) getFolders
(long groupId, double score, int start, int end) getFolders
(long groupId, long parentFolderId, boolean includeMountfolders, int status, int start, int end, OrderByComparator<DLFolder> orderByComparator) getFolders
(long groupId, long parentFolderId, int start, int end, OrderByComparator<DLFolder> orderByComparator) getFoldersAndFileEntriesAndFileShortcuts
(long groupId, long folderId, boolean includeMountFolders, int status, int start, int end, OrderByComparator<?> orderByComparator) getFoldersAndFileEntriesAndFileShortcuts
(long groupId, long folderId, String[] mimeTypes, boolean includeMountFolders, int status, int start, int end, OrderByComparator<?> orderByComparator) getFoldersAndFileEntriesAndFileShortcuts
(long groupId, long folderId, String[] mimeTypes, boolean includeMountFolders, QueryDefinition<?> queryDefinition) getFoldersAndFileEntriesAndFileShortcuts
(long groupId, long folderId, String[] mimeTypes, long fileEntryTypeId, boolean includeMountFolders, int status, int start, int end, OrderByComparator<?> orderByComparator) static int
getFoldersAndFileEntriesAndFileShortcutsCount
(long groupId, long folderId, int status, boolean includeMountFolders) static int
getFoldersAndFileEntriesAndFileShortcutsCount
(long groupId, long folderId, int status, String[] mimeTypes, boolean includeMountFolders) Deprecated.static int
getFoldersAndFileEntriesAndFileShortcutsCount
(long groupId, long folderId, String[] mimeTypes, boolean includeMountFolders, int status) static int
getFoldersAndFileEntriesAndFileShortcutsCount
(long groupId, long folderId, String[] mimeTypes, boolean includeMountFolders, QueryDefinition<?> queryDefinition) static int
getFoldersAndFileEntriesAndFileShortcutsCount
(long groupId, long folderId, String[] mimeTypes, long fileEntryTypeId, boolean includeMountFolders, int status) static int
getFoldersCount
(long groupId, double score) static int
getFoldersCount
(long groupId, long parentFolderId) static int
getFoldersCount
(long groupId, long parentFolderId, boolean includeMountfolders, int status) static int
getFoldersCount
(long groupId, long parentFolderId, int status, boolean includeMountfolders) Deprecated.As of Athanasius (7.3.x), replaced bygetFoldersCount(long, long, boolean, int)
getMountFolders
(long groupId, long parentFolderId, int start, int end, OrderByComparator<DLFolder> orderByComparator) static int
getMountFoldersCount
(long groupId, long parentFolderId) static String
Returns the OSGi service identifier.static DLFolderService
getSubfolderIds
(long groupId, long folderId, boolean recurse) static void
getSubfolderIds
(List<Long> folderIds, long groupId, long folderId, boolean recurse) static boolean
hasFolderLock
(long folderId) static boolean
hasInheritableLock
(long folderId) static boolean
isFolderLocked
(long folderId) static Lock
lockFolder
(long folderId) static Lock
lockFolder
(long folderId, String owner, boolean inheritable, long expirationTime) static DLFolder
moveFolder
(long folderId, long parentFolderId, ServiceContext serviceContext) static Lock
refreshFolderLock
(String lockUuid, long companyId, long expirationTime) static void
setService
(DLFolderService service) static void
unlockFolder
(long groupId, long parentFolderId, String name, String lockUuid) static void
unlockFolder
(long folderId, String lockUuid) static DLFolder
updateFolder
(long folderId, long parentFolderId, String name, String description, long defaultFileEntryTypeId, List<Long> fileEntryTypeIds, int restrictionType, ServiceContext serviceContext) static DLFolder
updateFolder
(long folderId, String name, String description, long defaultFileEntryTypeId, List<Long> fileEntryTypeIds, int restrictionType, ServiceContext serviceContext) static boolean
verifyInheritableLock
(long folderId, String lockUuid)
-
Constructor Details
-
DLFolderServiceUtil
public DLFolderServiceUtil()
-
-
Method Details
-
addFolder
public static DLFolder addFolder(String externalReferenceCode, long groupId, long repositoryId, boolean mountPoint, long parentFolderId, String name, String description, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
deleteFolder
- Throws:
PortalException
-
deleteFolder
public static void deleteFolder(long folderId, boolean includeTrashedEntries) throws PortalException - Throws:
PortalException
-
deleteFolder
public static void deleteFolder(long groupId, long parentFolderId, String name) throws PortalException - Throws:
PortalException
-
getDLFolderByExternalReferenceCode
public static DLFolder getDLFolderByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException - Throws:
PortalException
-
getFileEntriesAndFileShortcuts
public static List<Object> getFileEntriesAndFileShortcuts(long groupId, long folderId, int status, int start, int end) throws PortalException - Throws:
PortalException
-
getFileEntriesAndFileShortcutsCount
public static int getFileEntriesAndFileShortcutsCount(long groupId, long folderId, int status) throws PortalException - Throws:
PortalException
-
getFileEntriesAndFileShortcutsCount
public static int getFileEntriesAndFileShortcutsCount(long groupId, long folderId, String[] mimeTypes, int status) throws PortalException - Throws:
PortalException
-
getFolder
- Throws:
PortalException
-
getFolder
public static DLFolder getFolder(long groupId, long parentFolderId, String name) throws PortalException - Throws:
PortalException
-
getFolderIds
- Throws:
PortalException
-
getFolders
public static List<DLFolder> getFolders(long groupId, double score, int start, int end) throws PortalException - Throws:
PortalException
-
getFolders
public static List<DLFolder> getFolders(long groupId, long parentFolderId, boolean includeMountfolders, int status, int start, int end, OrderByComparator<DLFolder> orderByComparator) throws PortalException - Throws:
PortalException
-
getFolders
public static List<DLFolder> getFolders(long groupId, long parentFolderId, int start, int end, OrderByComparator<DLFolder> orderByComparator) throws PortalException - Throws:
PortalException
-
getFoldersAndFileEntriesAndFileShortcuts
public static List<Object> getFoldersAndFileEntriesAndFileShortcuts(long groupId, long folderId, boolean includeMountFolders, int status, int start, int end, OrderByComparator<?> orderByComparator) throws PortalException - Throws:
PortalException
-
getFoldersAndFileEntriesAndFileShortcuts
public static List<Object> getFoldersAndFileEntriesAndFileShortcuts(long groupId, long folderId, String[] mimeTypes, boolean includeMountFolders, int status, int start, int end, OrderByComparator<?> orderByComparator) throws PortalException - Throws:
PortalException
-
getFoldersAndFileEntriesAndFileShortcuts
public static List<Object> getFoldersAndFileEntriesAndFileShortcuts(long groupId, long folderId, String[] mimeTypes, boolean includeMountFolders, QueryDefinition<?> queryDefinition) throws PortalException - Throws:
PortalException
-
getFoldersAndFileEntriesAndFileShortcuts
public static List<Object> getFoldersAndFileEntriesAndFileShortcuts(long groupId, long folderId, String[] mimeTypes, long fileEntryTypeId, boolean includeMountFolders, int status, int start, int end, OrderByComparator<?> orderByComparator) throws PortalException - Throws:
PortalException
-
getFoldersAndFileEntriesAndFileShortcutsCount
public static int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId, long folderId, int status, boolean includeMountFolders) throws PortalException - Throws:
PortalException
-
getFoldersAndFileEntriesAndFileShortcutsCount
@Deprecated public static int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId, long folderId, int status, String[] mimeTypes, boolean includeMountFolders) throws PortalException Deprecated.As of Athanasius (7.3.x), replaced bygetFoldersAndFileEntriesAndFileShortcutsCount(long, long, String[], boolean, int)
- Throws:
PortalException
-
getFoldersAndFileEntriesAndFileShortcutsCount
public static int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId, long folderId, String[] mimeTypes, boolean includeMountFolders, int status) throws PortalException - Throws:
PortalException
-
getFoldersAndFileEntriesAndFileShortcutsCount
public static int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId, long folderId, String[] mimeTypes, boolean includeMountFolders, QueryDefinition<?> queryDefinition) throws PortalException - Throws:
PortalException
-
getFoldersAndFileEntriesAndFileShortcutsCount
public static int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId, long folderId, String[] mimeTypes, long fileEntryTypeId, boolean includeMountFolders, int status) throws PortalException - Throws:
PortalException
-
getFoldersCount
- Throws:
PortalException
-
getFoldersCount
- Throws:
PortalException
-
getFoldersCount
public static int getFoldersCount(long groupId, long parentFolderId, boolean includeMountfolders, int status) throws PortalException - Throws:
PortalException
-
getFoldersCount
@Deprecated public static int getFoldersCount(long groupId, long parentFolderId, int status, boolean includeMountfolders) throws PortalException Deprecated.As of Athanasius (7.3.x), replaced bygetFoldersCount(long, long, boolean, int)
- Throws:
PortalException
-
getMountFolders
public static List<DLFolder> getMountFolders(long groupId, long parentFolderId, int start, int end, OrderByComparator<DLFolder> orderByComparator) throws PortalException - Throws:
PortalException
-
getMountFoldersCount
- Throws:
PortalException
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getSubfolderIds
public static void getSubfolderIds(List<Long> folderIds, long groupId, long folderId, boolean recurse) throws PortalException - Throws:
PortalException
-
getSubfolderIds
public static List<Long> getSubfolderIds(long groupId, long folderId, boolean recurse) throws PortalException - Throws:
PortalException
-
hasFolderLock
- Throws:
PortalException
-
hasInheritableLock
- Throws:
PortalException
-
isFolderLocked
public static boolean isFolderLocked(long folderId) -
lockFolder
- Throws:
PortalException
-
lockFolder
public static Lock lockFolder(long folderId, String owner, boolean inheritable, long expirationTime) throws PortalException - Throws:
PortalException
-
moveFolder
public static DLFolder moveFolder(long folderId, long parentFolderId, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
refreshFolderLock
public static Lock refreshFolderLock(String lockUuid, long companyId, long expirationTime) throws PortalException - Throws:
PortalException
-
unlockFolder
public static void unlockFolder(long groupId, long parentFolderId, String name, String lockUuid) throws PortalException - Throws:
PortalException
-
unlockFolder
- Throws:
PortalException
-
updateFolder
public static DLFolder updateFolder(long folderId, long parentFolderId, String name, String description, long defaultFileEntryTypeId, List<Long> fileEntryTypeIds, int restrictionType, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
updateFolder
public static DLFolder updateFolder(long folderId, String name, String description, long defaultFileEntryTypeId, List<Long> fileEntryTypeIds, int restrictionType, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
verifyInheritableLock
- Throws:
PortalException
-
getService
-
setService
-
getFoldersAndFileEntriesAndFileShortcutsCount(long, long, String[], boolean, int)