Liferay 7.0-ce-b4

com.liferay.portlet.documentlibrary.service
Interface DLFolderService

All Superinterfaces:
BaseService
All Known Implementing Classes:
DLFolderServiceWrapper

@AccessControlled
@JSONWebService
@ProviderType
@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, 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 folderId, boolean includeTrashedEntries)
           
 void deleteFolder(long groupId, long parentFolderId, String name)
           
 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)
           
 List<Long> getFolderIds(long groupId, long folderId)
           
 List<DLFolder> getFolders(long groupId, long parentFolderId, int status, boolean includeMountfolders, int start, int end, OrderByComparator<DLFolder> obc)
           
 List<DLFolder> getFolders(long groupId, long parentFolderId, int start, int end, OrderByComparator<DLFolder> obc)
           
 List<Object> getFoldersAndFileEntriesAndFileShortcuts(long groupId, long folderId, int status, boolean includeMountFolders, int start, int end, OrderByComparator<?> obc)
           
 List<Object> getFoldersAndFileEntriesAndFileShortcuts(long groupId, long folderId, int status, String[] mimeTypes, boolean includeMountFolders, int start, int end, OrderByComparator<?> obc)
           
 List<Object> getFoldersAndFileEntriesAndFileShortcuts(long groupId, long folderId, String[] mimeTypes, boolean includeMountFolders, QueryDefinition<?> queryDefinition)
           
 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, int status, boolean includeMountfolders)
           
 List<DLFolder> getMountFolders(long groupId, long parentFolderId, int start, int end, OrderByComparator<DLFolder> obc)
           
 int getMountFoldersCount(long groupId, long parentFolderId)
           
 String getOSGiServiceIdentifier()
          Returns the OSGi service identifier.
 void getSubfolderIds(List<Long> folderIds, long groupId, long folderId)
          Deprecated. As of 7.0.0, replaced by getSubfolderIds(List, long, long, boolean)
 void getSubfolderIds(List<Long> folderIds, long groupId, long folderId, boolean recurse)
           
 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 companyId, long expirationTime)
           
 void unlockFolder(long groupId, long parentFolderId, String name, String lockUuid)
           
 void unlockFolder(long folderId, String lockUuid)
           
 DLFolder updateFolder(long folderId, long parentFolderId, String name, String description, long defaultFileEntryTypeId, List<Long> fileEntryTypeIds, int restrictionType, ServiceContext serviceContext)
           
 DLFolder updateFolder(long folderId, String name, String description, long defaultFileEntryTypeId, List<Long> fileEntryTypeIds, boolean overrideFileEntryTypes, ServiceContext serviceContext)
          Deprecated. As of 7.0.0, replaced by more general updateFolder(long, String, String, long, List, int, ServiceContext)
 DLFolder updateFolder(long folderId, String name, String description, long defaultFileEntryTypeId, List<Long> fileEntryTypeIds, int restrictionType, ServiceContext serviceContext)
           
 boolean verifyInheritableLock(long folderId, String lockUuid)
           
 

Method Detail

addFolder

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

deleteFolder

void deleteFolder(long folderId)
                  throws PortalException
Throws:
PortalException

deleteFolder

void deleteFolder(long folderId,
                  boolean includeTrashedEntries)
                  throws PortalException
Throws:
PortalException

deleteFolder

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

getFileEntriesAndFileShortcuts

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

getFileEntriesAndFileShortcutsCount

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

getFileEntriesAndFileShortcutsCount

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

getFolder

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

getFolder

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

getFolderIds

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

getFolders

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

getFolders

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

getFoldersAndFileEntriesAndFileShortcuts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Object> getFoldersAndFileEntriesAndFileShortcuts(long groupId,
                                                                                               long folderId,
                                                                                               String[] mimeTypes,
                                                                                               boolean includeMountFolders,
                                                                                               QueryDefinition<?> queryDefinition)
                                                      throws PortalException
Throws:
PortalException

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
Throws:
PortalException

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
Throws:
PortalException

getFoldersAndFileEntriesAndFileShortcutsCount

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

getFoldersAndFileEntriesAndFileShortcutsCount

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

getFoldersCount

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

getFoldersCount

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

getMountFolders

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

getMountFoldersCount

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

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()
Returns the OSGi service identifier.

Returns:
the OSGi service identifier

getSubfolderIds

@Deprecated
@Transactional(propagation=SUPPORTS,
               readOnly=true)
void getSubfolderIds(List<Long> folderIds,
                                                                         long groupId,
                                                                         long folderId)
                     throws PortalException
Deprecated. As of 7.0.0, replaced by getSubfolderIds(List, long, long, boolean)

Throws:
PortalException

getSubfolderIds

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

getSubfolderIds

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

hasFolderLock

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

hasInheritableLock

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

isFolderLocked

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean isFolderLocked(long folderId)

lockFolder

Lock lockFolder(long folderId)
                throws PortalException
Throws:
PortalException

lockFolder

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

moveFolder

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

refreshFolderLock

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

unlockFolder

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

unlockFolder

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

updateFolder

@Deprecated
DLFolder updateFolder(long folderId,
                                 String name,
                                 String description,
                                 long defaultFileEntryTypeId,
                                 List<Long> fileEntryTypeIds,
                                 boolean overrideFileEntryTypes,
                                 ServiceContext serviceContext)
                      throws PortalException
Deprecated. As of 7.0.0, replaced by more general updateFolder(long, String, String, long, List, int, ServiceContext)

Throws:
PortalException

updateFolder

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

updateFolder

DLFolder updateFolder(long folderId,
                      long parentFolderId,
                      String name,
                      String description,
                      long defaultFileEntryTypeId,
                      List<Long> fileEntryTypeIds,
                      int restrictionType,
                      ServiceContext serviceContext)
                      throws PortalException
Throws:
PortalException

verifyInheritableLock

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

Liferay 7.0-ce-b4