com.liferay.document.library.kernel.service

Class DLFolderServiceUtil

Object

com.liferay.document.library.kernel.service.DLFolderServiceUtil

public class DLFolderServiceUtil
extends Object

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:

DLFolderService

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
DLFolderServiceUtil()

Method Summary

Modifier and Type	Method and Description
static DLFolder	addFolder(long groupId, long repositoryId, boolean mountPoint, long parentFolderId, String name, String description, ServiceContext serviceContext) NOTE FOR DEVELOPERS: Never modify or reference this interface directly.
static void	deleteFolder(long folderId)
static void	deleteFolder(long folderId, boolean includeTrashedEntries)
static void	deleteFolder(long groupId, long parentFolderId, String name)
static List<Object>	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, int status, String[] mimeTypes)
static DLFolder	getFolder(long folderId)
static DLFolder	getFolder(long groupId, long parentFolderId, String name)
static List<Long>	getFolderIds(long groupId, long folderId)
static List<DLFolder>	getFolders(long groupId, long parentFolderId, int status, boolean includeMountfolders, int start, int end, OrderByComparator<DLFolder> obc)
static List<DLFolder>	getFolders(long groupId, long parentFolderId, int start, int end, OrderByComparator<DLFolder> obc)
static List<Object>	getFoldersAndFileEntriesAndFileShortcuts(long groupId, long folderId, int status, boolean includeMountFolders, int start, int end, OrderByComparator<?> obc)
static List<Object>	getFoldersAndFileEntriesAndFileShortcuts(long groupId, long folderId, int status, String[] mimeTypes, boolean includeMountFolders, int start, int end, OrderByComparator<?> obc)
static List<Object>	getFoldersAndFileEntriesAndFileShortcuts(long groupId, long folderId, String[] mimeTypes, boolean includeMountFolders, QueryDefinition<?> queryDefinition)
static int	getFoldersAndFileEntriesAndFileShortcutsCount(long groupId, long folderId, int status, boolean includeMountFolders)
static int	getFoldersAndFileEntriesAndFileShortcutsCount(long groupId, long folderId, int status, String[] mimeTypes, boolean includeMountFolders)
static int	getFoldersAndFileEntriesAndFileShortcutsCount(long groupId, long folderId, String[] mimeTypes, boolean includeMountFolders, QueryDefinition<?> queryDefinition)
static int	getFoldersCount(long groupId, long parentFolderId)
static int	getFoldersCount(long groupId, long parentFolderId, int status, boolean includeMountfolders)
static List<DLFolder>	getMountFolders(long groupId, long parentFolderId, int start, int end, OrderByComparator<DLFolder> obc)
static int	getMountFoldersCount(long groupId, long parentFolderId)
static String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static DLFolderService	getService()
static void	getSubfolderIds(List<Long> folderIds, long groupId, long folderId) Deprecated. As of Wilberforce (7.0.x), replaced by getSubfolderIds(List, long, long, boolean)
static void	getSubfolderIds(List<Long> folderIds, long groupId, long folderId, boolean recurse)
static List<Long>	getSubfolderIds(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	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, boolean overrideFileEntryTypes, ServiceContext serviceContext) Deprecated. As of Wilberforce (7.0.x), replaced by more general updateFolder(long, String, String, long, List, int, 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)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DLFolderServiceUtil

public DLFolderServiceUtil()

Method Detail

addFolder

public static DLFolder addFolder(long groupId,
                                 long repositoryId,
                                 boolean mountPoint,
                                 long parentFolderId,
                                 String name,
                                 String description,
                                 ServiceContext serviceContext)
                          throws PortalException

NOTE FOR DEVELOPERS: Never modify or reference this interface directly. Always use DLFolderServiceUtil to access the document library folder remote service. Add custom service methods to com.liferay.portlet.documentlibrary.service.impl.DLFolderServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

Throws:

PortalException

deleteFolder

public static void deleteFolder(long folderId)
                         throws PortalException

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

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,
                                                      int status,
                                                      String[] mimeTypes)
                                               throws PortalException

Throws:

PortalException

getFolder

public static DLFolder getFolder(long folderId)
                          throws PortalException

Throws:

PortalException

getFolder

public static DLFolder getFolder(long groupId,
                                 long parentFolderId,
                                 String name)
                          throws PortalException

Throws:

PortalException

getFolderIds

public static List<Long> getFolderIds(long groupId,
                                      long folderId)
                               throws PortalException

Throws:

PortalException

getFolders

public static List<DLFolder> getFolders(long groupId,
                                        long parentFolderId,
                                        int status,
                                        boolean includeMountfolders,
                                        int start,
                                        int end,
                                        OrderByComparator<DLFolder> obc)
                                 throws PortalException

Throws:

PortalException

getFolders

public static List<DLFolder> getFolders(long groupId,
                                        long parentFolderId,
                                        int start,
                                        int end,
                                        OrderByComparator<DLFolder> obc)
                                 throws PortalException

Throws:

PortalException

getFoldersAndFileEntriesAndFileShortcuts

public static List<Object> getFoldersAndFileEntriesAndFileShortcuts(long groupId,
                                                                    long folderId,
                                                                    int status,
                                                                    boolean includeMountFolders,
                                                                    int start,
                                                                    int end,
                                                                    OrderByComparator<?> obc)
                                                             throws PortalException

Throws:

PortalException

getFoldersAndFileEntriesAndFileShortcuts

public static List<Object> getFoldersAndFileEntriesAndFileShortcuts(long groupId,
                                                                    long folderId,
                                                                    int status,
                                                                    String[] mimeTypes,
                                                                    boolean includeMountFolders,
                                                                    int start,
                                                                    int end,
                                                                    OrderByComparator<?> obc)
                                                             throws PortalException

Throws:

PortalException

getFoldersAndFileEntriesAndFileShortcuts

public static List<Object> getFoldersAndFileEntriesAndFileShortcuts(long groupId,
                                                                    long folderId,
                                                                    String[] mimeTypes,
                                                                    boolean includeMountFolders,
                                                                    QueryDefinition<?> queryDefinition)
                                                             throws PortalException

Throws:

PortalException

getFoldersAndFileEntriesAndFileShortcutsCount

public static int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
                                                                long folderId,
                                                                int status,
                                                                boolean includeMountFolders)
                                                         throws PortalException

Throws:

PortalException

getFoldersAndFileEntriesAndFileShortcutsCount

public static int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
                                                                long folderId,
                                                                int status,
                                                                String[] mimeTypes,
                                                                boolean includeMountFolders)
                                                         throws PortalException

Throws:

PortalException

getFoldersAndFileEntriesAndFileShortcutsCount

public static int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
                                                                long folderId,
                                                                String[] mimeTypes,
                                                                boolean includeMountFolders,
                                                                QueryDefinition<?> queryDefinition)
                                                         throws PortalException

Throws:

PortalException

getFoldersCount

public static int getFoldersCount(long groupId,
                                  long parentFolderId)
                           throws PortalException

Throws:

PortalException

getFoldersCount

public static int getFoldersCount(long groupId,
                                  long parentFolderId,
                                  int status,
                                  boolean includeMountfolders)
                           throws PortalException

Throws:

PortalException

getMountFolders

public static List<DLFolder> getMountFolders(long groupId,
                                             long parentFolderId,
                                             int start,
                                             int end,
                                             OrderByComparator<DLFolder> obc)
                                      throws PortalException

Throws:

PortalException

getMountFoldersCount

public static int getMountFoldersCount(long groupId,
                                       long parentFolderId)
                                throws PortalException

Throws:

PortalException

getOSGiServiceIdentifier

public static String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getSubfolderIds

@Deprecated
public static void getSubfolderIds(List<Long> folderIds,
                                               long groupId,
                                               long folderId)
                                        throws PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by getSubfolderIds(List, long, long, boolean)

Throws:

PortalException

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

public static boolean hasFolderLock(long folderId)
                             throws PortalException

Throws:

PortalException

hasInheritableLock

public static boolean hasInheritableLock(long folderId)
                                  throws PortalException

Throws:

PortalException

isFolderLocked

public static boolean isFolderLocked(long folderId)

lockFolder

public static Lock lockFolder(long folderId)
                       throws PortalException

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

public static void unlockFolder(long folderId,
                                String lockUuid)
                         throws PortalException

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

@Deprecated
public static DLFolder updateFolder(long folderId,
                                                String name,
                                                String description,
                                                long defaultFileEntryTypeId,
                                                List<Long> fileEntryTypeIds,
                                                boolean overrideFileEntryTypes,
                                                ServiceContext serviceContext)
                                         throws PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by more general updateFolder(long, String, String, long, List, int, ServiceContext)

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

public static boolean verifyInheritableLock(long folderId,
                                            String lockUuid)
                                     throws PortalException

Throws:

PortalException

getService

public static DLFolderService getService()