Liferay 6.2.0

com.liferay.portlet.documentlibrary.service
Interface DLFolderService

All Superinterfaces:
BaseService
All Known Implementing Classes:
DLFolderServiceBaseImpl, DLFolderServiceImpl, DLFolderServiceWrapper

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

Provides the remote service interface for DLFolder. 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, DLFolderServiceBaseImpl, DLFolderServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

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

getFileEntriesAndFileShortcutsCount

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

getFileEntriesAndFileShortcutsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFileEntriesAndFileShortcutsCount(long groupId,
                                                                                 long folderId,
                                                                                 int status,
                                                                                 String[] mimeTypes)
                                        throws PortalException,
                                               SystemException
Throws:
PortalException
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)
List<Long> getFolderIds(long groupId,
                                                                 long folderId)
                        throws PortalException,
                               SystemException
Throws:
PortalException
SystemException

getFolders

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

getFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFolder> getFolders(long groupId,
                                                                   long parentFolderId,
                                                                   int start,
                                                                   int end,
                                                                   OrderByComparator obc)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
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 PortalException,
                                                             SystemException
Throws:
PortalException
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 PortalException,
                                                             SystemException
Throws:
PortalException
SystemException

getFoldersAndFileEntriesAndFileShortcutsCount

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

getFoldersAndFileEntriesAndFileShortcutsCount

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

getFoldersCount

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

getFoldersCount

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

getMountFolders

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

getMountFoldersCount

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

getSubfolderIds

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

getSubfolderIds

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Long> getSubfolderIds(long groupId,
                                                                    long folderId,
                                                                    boolean recurse)
                           throws PortalException,
                                  SystemException
Throws:
PortalException
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 companyId,
                       long expirationTime)
                       throws PortalException,
                              SystemException
Throws:
PortalException
SystemException

unlockFolder

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

unlockFolder

void unlockFolder(long folderId,
                  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.2.0