Liferay 6.1.2-ce-ga3

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 document library 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.

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 it is generated.

Constructor Summary
DLFolderServiceUtil()
           
 
Method Summary
static DLFolder addFolder(long groupId, long repositoryId, boolean mountPoint, long parentFolderId, String name, String description, ServiceContext serviceContext)
           
static void deleteFolder(long folderId)
           
static void deleteFolder(long groupId, long parentFolderId, String name)
           
static String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
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 long[] getFolderIds(long groupId, long folderId)
           
static List<DLFolder> getFolders(long groupId, long parentFolderId, boolean includeMountfolders, int start, int end, OrderByComparator obc)
           
static List<DLFolder> getFolders(long groupId, long parentFolderId, int start, int end, OrderByComparator obc)
           
static List<Object> getFoldersAndFileEntriesAndFileShortcuts(long groupId, long folderId, int status, boolean includeMountFolders, int start, int end, OrderByComparator obc)
           
static int getFoldersAndFileEntriesAndFileShortcuts(long groupId, long folderId, int status, String[] mimeTypes, boolean includeMountFolders)
           
static List<Object> getFoldersAndFileEntriesAndFileShortcuts(long groupId, long folderId, int status, String[] mimeTypes, boolean includeMountFolders, int start, int end, OrderByComparator obc)
           
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 getFoldersCount(long groupId, long parentFolderId)
           
static int getFoldersCount(long groupId, long parentFolderId, boolean includeMountfolders)
           
static List<DLFolder> getMountFolders(long groupId, long parentFolderId, int start, int end, OrderByComparator obc)
           
static int getMountFoldersCount(long groupId, long parentFolderId)
           
static DLFolderService getService()
           
static void getSubfolderIds(List<Long> folderIds, long groupId, long folderId)
           
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 expirationTime)
           
static void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void setService(DLFolderService service)
          Deprecated.  
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, String name, String description, long defaultFileEntryTypeId, List<Long> fileEntryTypeIds, boolean overrideFileEntryTypes, 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

getBeanIdentifier

public static String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

addFolder

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

deleteFolder

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

deleteFolder

public static void deleteFolder(long groupId,
                                long parentFolderId,
                                String name)
                         throws PortalException,
                                SystemException
Throws:
PortalException
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,
                                                      long folderId,
                                                      int status)
                                               throws SystemException
Throws:
SystemException

getFileEntriesAndFileShortcutsCount

public static int getFileEntriesAndFileShortcutsCount(long groupId,
                                                      long folderId,
                                                      int status,
                                                      String[] mimeTypes)
                                               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

getFolderIds

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

getFolders

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

getFolders

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

getFoldersAndFileEntriesAndFileShortcuts

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

getFoldersAndFileEntriesAndFileShortcuts

public static int getFoldersAndFileEntriesAndFileShortcuts(long groupId,
                                                           long folderId,
                                                           int status,
                                                           String[] mimeTypes,
                                                           boolean includeMountFolders)
                                                    throws SystemException
Throws:
SystemException

getFoldersAndFileEntriesAndFileShortcuts

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

getFoldersAndFileEntriesAndFileShortcutsCount

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

getFoldersAndFileEntriesAndFileShortcutsCount

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

getFoldersCount

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

getFoldersCount

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

getMountFolders

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

getMountFoldersCount

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

getSubfolderIds

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

getSubfolderIds

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

hasFolderLock

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

hasInheritableLock

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

isFolderLocked

public static boolean isFolderLocked(long folderId)
                              throws SystemException
Throws:
SystemException

lockFolder

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

lockFolder

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

moveFolder

public static DLFolder moveFolder(long folderId,
                                  long parentFolderId,
                                  ServiceContext serviceContext)
                           throws PortalException,
                                  SystemException
Throws:
PortalException
SystemException

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,
                                    String name,
                                    String description,
                                    long defaultFileEntryTypeId,
                                    List<Long> fileEntryTypeIds,
                                    boolean overrideFileEntryTypes,
                                    ServiceContext serviceContext)
                             throws PortalException,
                                    SystemException
Throws:
PortalException
SystemException

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)
Deprecated. 


Liferay 6.1.2-ce-ga3