Liferay 6.0.5

com.liferay.portlet.documentlibrary.service
Class DLFolderServiceUtil

java.lang.Object
  extended by com.liferay.portlet.documentlibrary.service.DLFolderServiceUtil

public class DLFolderServiceUtil
extends Object

The utility for the d l folder remote service. This utility wraps DLFolderServiceImpl and is the primary access point for service operations in application layer code running on a remote server.

Never modify this class directly. Add custom service methods to DLFolderServiceImpl and rerun ServiceBuilder to regenerate this class.

This is a remote service. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.

See Also:
DLFolderService, DLFolderServiceBaseImpl, DLFolderServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Constructor Summary
DLFolderServiceUtil()
           
 
Method Summary
static DLFolder addFolder(long groupId, long parentFolderId, String name, String description, ServiceContext serviceContext)
           
static DLFolder copyFolder(long groupId, long sourceFolderId, long parentFolderId, String name, String description, ServiceContext serviceContext)
           
static void deleteFolder(long folderId)
           
static void deleteFolder(long groupId, long parentFolderId, String name)
           
static List<Object> getFileEntriesAndFileShortcuts(long groupId, List<Long> folderIds, int status, int start, int end)
           
static List<Object> getFileEntriesAndFileShortcuts(long groupId, long folderId, int status, int start, int end)
           
static int getFileEntriesAndFileShortcutsCount(long groupId, List<Long> folderIds, int status)
           
static int getFileEntriesAndFileShortcutsCount(long groupId, long folderId, int status)
           
static DLFolder getFolder(long folderId)
           
static DLFolder getFolder(long groupId, long parentFolderId, String name)
           
static long getFolderId(long groupId, long parentFolderId, String name)
           
static long[] getFolderIds(long groupId, long folderId)
           
static List<DLFolder> getFolders(long groupId, long parentFolderId)
           
static List<DLFolder> getFolders(long groupId, long parentFolderId, int start, int end)
           
static List<Object> getFoldersAndFileEntriesAndFileShortcuts(long groupId, List<Long> folderIds, int status, int start, int end)
           
static List<Object> getFoldersAndFileEntriesAndFileShortcuts(long groupId, long folderId, int status, int start, int end)
           
static int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId, List<Long> folderIds, int status)
           
static int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId, long folderId, int status)
           
static int getFoldersCount(long groupId, long parentFolderId)
           
static DLFolderService getService()
           
static void getSubfolderIds(List<Long> folderIds, long groupId, long folderId)
           
static boolean hasInheritableLock(long folderId)
           
static Lock lockFolder(long folderId)
           
static Lock lockFolder(long folderId, String owner, boolean inheritable, long expirationTime)
           
static Lock refreshFolderLock(String lockUuid, long expirationTime)
           
 void setService(DLFolderService service)
           
static void unlockFolder(long groupId, long folderId, String lockUuid)
           
static void unlockFolder(long groupId, long parentFolderId, String name, String lockUuid)
           
static DLFolder updateFolder(long folderId, long parentFolderId, String name, String description, ServiceContext serviceContext)
           
static boolean verifyInheritableLock(long folderId, String lockUuid)
           
 
Methods inherited from class java.lang.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 parentFolderId,
                                 String name,
                                 String description,
                                 ServiceContext serviceContext)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

copyFolder

public static DLFolder copyFolder(long groupId,
                                  long sourceFolderId,
                                  long parentFolderId,
                                  String name,
                                  String description,
                                  ServiceContext serviceContext)
                           throws PortalException,
                                  SystemException,
                                  RemoteException
Throws:
PortalException
SystemException
RemoteException

deleteFolder

public static void deleteFolder(long folderId)
                         throws PortalException,
                                SystemException,
                                RemoteException
Throws:
PortalException
SystemException
RemoteException

deleteFolder

public static void deleteFolder(long groupId,
                                long parentFolderId,
                                String name)
                         throws PortalException,
                                SystemException,
                                RemoteException
Throws:
PortalException
SystemException
RemoteException

getFileEntriesAndFileShortcuts

public static List<Object> getFileEntriesAndFileShortcuts(long groupId,
                                                          List<Long> folderIds,
                                                          int status,
                                                          int start,
                                                          int end)
                                                   throws SystemException
Throws:
SystemException

getFileEntriesAndFileShortcuts

public static List<Object> getFileEntriesAndFileShortcuts(long groupId,
                                                          long folderId,
                                                          int status,
                                                          int start,
                                                          int end)
                                                   throws SystemException
Throws:
SystemException

getFileEntriesAndFileShortcutsCount

public static int getFileEntriesAndFileShortcutsCount(long groupId,
                                                      List<Long> folderIds,
                                                      int status)
                                               throws SystemException
Throws:
SystemException

getFileEntriesAndFileShortcutsCount

public static int getFileEntriesAndFileShortcutsCount(long groupId,
                                                      long folderId,
                                                      int status)
                                               throws SystemException
Throws:
SystemException

getFolder

public static DLFolder getFolder(long folderId)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

getFolder

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

getFolderId

public static long getFolderId(long groupId,
                               long parentFolderId,
                               String name)
                        throws PortalException,
                               SystemException
Throws:
PortalException
SystemException

getFolderIds

public static long[] getFolderIds(long groupId,
                                  long folderId)
                           throws SystemException
Throws:
SystemException

getFolders

public static List<DLFolder> getFolders(long groupId,
                                        long parentFolderId)
                                 throws SystemException
Throws:
SystemException

getFolders

public static List<DLFolder> getFolders(long groupId,
                                        long parentFolderId,
                                        int start,
                                        int end)
                                 throws SystemException
Throws:
SystemException

getFoldersAndFileEntriesAndFileShortcuts

public static List<Object> getFoldersAndFileEntriesAndFileShortcuts(long groupId,
                                                                    List<Long> folderIds,
                                                                    int status,
                                                                    int start,
                                                                    int end)
                                                             throws SystemException
Throws:
SystemException

getFoldersAndFileEntriesAndFileShortcuts

public static List<Object> getFoldersAndFileEntriesAndFileShortcuts(long groupId,
                                                                    long folderId,
                                                                    int status,
                                                                    int start,
                                                                    int end)
                                                             throws PortalException,
                                                                    SystemException
Throws:
PortalException
SystemException

getFoldersAndFileEntriesAndFileShortcutsCount

public static int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
                                                                List<Long> folderIds,
                                                                int status)
                                                         throws SystemException
Throws:
SystemException

getFoldersAndFileEntriesAndFileShortcutsCount

public static int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
                                                                long folderId,
                                                                int status)
                                                         throws PortalException,
                                                                SystemException
Throws:
PortalException
SystemException

getFoldersCount

public static int getFoldersCount(long groupId,
                                  long parentFolderId)
                           throws SystemException
Throws:
SystemException

getSubfolderIds

public static void getSubfolderIds(List<Long> folderIds,
                                   long groupId,
                                   long folderId)
                            throws SystemException
Throws:
SystemException

hasInheritableLock

public static boolean hasInheritableLock(long folderId)
                                  throws PortalException,
                                         SystemException
Throws:
PortalException
SystemException

lockFolder

public static Lock lockFolder(long folderId)
                       throws PortalException,
                              SystemException,
                              RemoteException
Throws:
PortalException
SystemException
RemoteException

lockFolder

public static Lock lockFolder(long folderId,
                              String owner,
                              boolean inheritable,
                              long expirationTime)
                       throws PortalException,
                              SystemException,
                              RemoteException
Throws:
PortalException
SystemException
RemoteException

refreshFolderLock

public static Lock refreshFolderLock(String lockUuid,
                                     long expirationTime)
                              throws PortalException,
                                     SystemException
Throws:
PortalException
SystemException

unlockFolder

public static void unlockFolder(long groupId,
                                long folderId,
                                String lockUuid)
                         throws PortalException,
                                SystemException
Throws:
PortalException
SystemException

unlockFolder

public static void unlockFolder(long groupId,
                                long parentFolderId,
                                String name,
                                String lockUuid)
                         throws PortalException,
                                SystemException
Throws:
PortalException
SystemException

updateFolder

public static DLFolder updateFolder(long folderId,
                                    long parentFolderId,
                                    String name,
                                    String description,
                                    ServiceContext serviceContext)
                             throws PortalException,
                                    SystemException,
                                    RemoteException
Throws:
PortalException
SystemException
RemoteException

verifyInheritableLock

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

getService

public static DLFolderService getService()

setService

public void setService(DLFolderService service)

Liferay 6.0.5