Liferay 6.1.2-ce-ga3

com.liferay.portlet.documentlibrary.service
Interface DLFolderService

All Superinterfaces:
BaseService
All Known Implementing Classes:
DLFolderServiceWrapper

@JSONWebService
@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface DLFolderService
extends BaseService

The interface for the document library folder remote service.

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:
DLFolderServiceUtil, com.liferay.portlet.documentlibrary.service.base.DLFolderServiceBaseImpl, com.liferay.portlet.documentlibrary.service.impl.DLFolderServiceImpl

Method Summary
 DLFolder addFolder(long groupId, long repositoryId, boolean mountPoint, long parentFolderId, String name, String description, ServiceContext serviceContext)
           
 void deleteFolder(long folderId)
           
 void deleteFolder(long groupId, long parentFolderId, String name)
           
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 List<Object> getFileEntriesAndFileShortcuts(long groupId, long folderId, int status, int start, int end)
           
 int getFileEntriesAndFileShortcutsCount(long groupId, long folderId, int status)
           
 int getFileEntriesAndFileShortcutsCount(long groupId, long folderId, int status, String[] mimeTypes)
           
 DLFolder getFolder(long folderId)
           
 DLFolder getFolder(long groupId, long parentFolderId, String name)
           
 long[] getFolderIds(long groupId, long folderId)
           
 List<DLFolder> getFolders(long groupId, long parentFolderId, boolean includeMountfolders, int start, int end, OrderByComparator obc)
           
 List<DLFolder> getFolders(long groupId, long parentFolderId, int start, int end, OrderByComparator obc)
           
 List<Object> getFoldersAndFileEntriesAndFileShortcuts(long groupId, long folderId, int status, boolean includeMountFolders, int start, int end, OrderByComparator obc)
           
 int getFoldersAndFileEntriesAndFileShortcuts(long groupId, long folderId, int status, String[] mimeTypes, boolean includeMountFolders)
           
 List<Object> getFoldersAndFileEntriesAndFileShortcuts(long groupId, long folderId, int status, String[] mimeTypes, boolean includeMountFolders, int start, int end, OrderByComparator obc)
           
 int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId, long folderId, int status, boolean includeMountFolders)
           
 int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId, long folderId, int status, String[] mimeTypes, boolean includeMountFolders)
           
 int getFoldersCount(long groupId, long parentFolderId)
           
 int getFoldersCount(long groupId, long parentFolderId, boolean includeMountfolders)
           
 List<DLFolder> getMountFolders(long groupId, long parentFolderId, int start, int end, OrderByComparator obc)
           
 int getMountFoldersCount(long groupId, long parentFolderId)
           
 void getSubfolderIds(List<Long> folderIds, long groupId, long folderId)
           
 List<Long> getSubfolderIds(long groupId, long folderId, boolean recurse)
           
 boolean hasFolderLock(long folderId)
           
 boolean hasInheritableLock(long folderId)
           
 boolean isFolderLocked(long folderId)
           
 Lock lockFolder(long folderId)
           
 Lock lockFolder(long folderId, String owner, boolean inheritable, long expirationTime)
           
 DLFolder moveFolder(long folderId, long parentFolderId, ServiceContext serviceContext)
           
 Lock refreshFolderLock(String lockUuid, long expirationTime)
           
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void unlockFolder(long groupId, long folderId, String lockUuid)
           
 void unlockFolder(long groupId, long parentFolderId, String name, String lockUuid)
           
 DLFolder updateFolder(long folderId, String name, String description, long defaultFileEntryTypeId, List<Long> fileEntryTypeIds, boolean overrideFileEntryTypes, ServiceContext serviceContext)
           
 boolean verifyInheritableLock(long folderId, String lockUuid)
           
 

Method Detail

getBeanIdentifier

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

Returns:
the Spring bean ID for this bean

setBeanIdentifier

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

Parameters:
beanIdentifier - the Spring bean ID for this bean

addFolder

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

deleteFolder

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

deleteFolder

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

getFileEntriesAndFileShortcuts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Object> getFileEntriesAndFileShortcuts(long groupId,
                                                                                     long folderId,
                                                                                     int status,
                                                                                     int start,
                                                                                     int end)
                                            throws SystemException
Throws:
SystemException

getFileEntriesAndFileShortcutsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFileEntriesAndFileShortcutsCount(long groupId,
                                                                                 long folderId,
                                                                                 int status)
                                        throws SystemException
Throws:
SystemException

getFileEntriesAndFileShortcutsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFileEntriesAndFileShortcutsCount(long groupId,
                                                                                 long folderId,
                                                                                 int status,
                                                                                 String[] mimeTypes)
                                        throws SystemException
Throws:
SystemException

getFolder

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFolder getFolder(long folderId)
                   throws PortalException,
                          SystemException
Throws:
PortalException
SystemException

getFolder

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFolder getFolder(long groupId,
                                                            long parentFolderId,
                                                            String name)
                   throws PortalException,
                          SystemException
Throws:
PortalException
SystemException

getFolderIds

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long[] getFolderIds(long groupId,
                                                             long folderId)
                    throws SystemException
Throws:
SystemException

getFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFolder> getFolders(long groupId,
                                                                   long parentFolderId,
                                                                   boolean includeMountfolders,
                                                                   int start,
                                                                   int end,
                                                                   OrderByComparator obc)
                          throws SystemException
Throws:
SystemException

getFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFolder> getFolders(long groupId,
                                                                   long parentFolderId,
                                                                   int start,
                                                                   int end,
                                                                   OrderByComparator obc)
                          throws SystemException
Throws:
SystemException

getFoldersAndFileEntriesAndFileShortcuts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Object> getFoldersAndFileEntriesAndFileShortcuts(long groupId,
                                                                                               long folderId,
                                                                                               int status,
                                                                                               boolean includeMountFolders,
                                                                                               int start,
                                                                                               int end,
                                                                                               OrderByComparator obc)
                                                      throws SystemException
Throws:
SystemException

getFoldersAndFileEntriesAndFileShortcuts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFoldersAndFileEntriesAndFileShortcuts(long groupId,
                                                                                      long folderId,
                                                                                      int status,
                                                                                      String[] mimeTypes,
                                                                                      boolean includeMountFolders)
                                             throws SystemException
Throws:
SystemException

getFoldersAndFileEntriesAndFileShortcuts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Object> getFoldersAndFileEntriesAndFileShortcuts(long groupId,
                                                                                               long folderId,
                                                                                               int status,
                                                                                               String[] mimeTypes,
                                                                                               boolean includeMountFolders,
                                                                                               int start,
                                                                                               int end,
                                                                                               OrderByComparator obc)
                                                      throws SystemException
Throws:
SystemException

getFoldersAndFileEntriesAndFileShortcutsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
                                                                                           long folderId,
                                                                                           int status,
                                                                                           boolean includeMountFolders)
                                                  throws SystemException
Throws:
SystemException

getFoldersAndFileEntriesAndFileShortcutsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
                                                                                           long folderId,
                                                                                           int status,
                                                                                           String[] mimeTypes,
                                                                                           boolean includeMountFolders)
                                                  throws SystemException
Throws:
SystemException

getFoldersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFoldersCount(long groupId,
                                                             long parentFolderId)
                    throws SystemException
Throws:
SystemException

getFoldersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFoldersCount(long groupId,
                                                             long parentFolderId,
                                                             boolean includeMountfolders)
                    throws SystemException
Throws:
SystemException

getMountFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFolder> getMountFolders(long groupId,
                                                                        long parentFolderId,
                                                                        int start,
                                                                        int end,
                                                                        OrderByComparator obc)
                               throws SystemException
Throws:
SystemException

getMountFoldersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getMountFoldersCount(long groupId,
                                                                  long parentFolderId)
                         throws SystemException
Throws:
SystemException

getSubfolderIds

@Transactional(propagation=SUPPORTS,
               readOnly=true)
void getSubfolderIds(List<Long> folderIds,
                                                              long groupId,
                                                              long folderId)
                     throws SystemException
Throws:
SystemException

getSubfolderIds

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Long> getSubfolderIds(long groupId,
                                                                    long folderId,
                                                                    boolean recurse)
                           throws SystemException
Throws:
SystemException

hasFolderLock

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasFolderLock(long folderId)
                      throws PortalException,
                             SystemException
Throws:
PortalException
SystemException

hasInheritableLock

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasInheritableLock(long folderId)
                           throws PortalException,
                                  SystemException
Throws:
PortalException
SystemException

isFolderLocked

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean isFolderLocked(long folderId)
                       throws SystemException
Throws:
SystemException

lockFolder

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

lockFolder

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

moveFolder

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

refreshFolderLock

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

unlockFolder

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

unlockFolder

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

updateFolder

DLFolder updateFolder(long folderId,
                      String name,
                      String description,
                      long defaultFileEntryTypeId,
                      List<Long> fileEntryTypeIds,
                      boolean overrideFileEntryTypes,
                      ServiceContext serviceContext)
                      throws PortalException,
                             SystemException
Throws:
PortalException
SystemException

verifyInheritableLock

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

Liferay 6.1.2-ce-ga3