com.liferay.portlet.documentlibrary.service
Interface DLFolderService

All Known Implementing Classes:

DLFolderServiceBaseImpl, DLFolderServiceImpl, DLFolderServiceWrapper

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

The interface for the d l folder remote service.

Never modify or reference this interface directly. Always use DLFolderServiceUtil to access the d l folder remote service. Add custom service methods to DLFolderServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

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, DLFolderServiceBaseImpl, DLFolderServiceImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary

DLFolder	addFolder(long groupId, long parentFolderId, String name, String description, ServiceContext serviceContext)
DLFolder	copyFolder(long groupId, long sourceFolderId, long parentFolderId, String name, String description, ServiceContext serviceContext)
void	deleteFolder(long folderId)
void	deleteFolder(long groupId, long parentFolderId, String name)
List<Object>	getFileEntriesAndFileShortcuts(long groupId, List<Long> folderIds, int status, int start, int end)
List<Object>	getFileEntriesAndFileShortcuts(long groupId, long folderId, int status, int start, int end)
int	getFileEntriesAndFileShortcutsCount(long groupId, List<Long> folderIds, int status)
int	getFileEntriesAndFileShortcutsCount(long groupId, long folderId, int status)
DLFolder	getFolder(long folderId)
DLFolder	getFolder(long groupId, long parentFolderId, String name)
long	getFolderId(long groupId, long parentFolderId, String name)
long[]	getFolderIds(long groupId, long folderId)
List<DLFolder>	getFolders(long groupId, long parentFolderId)
List<DLFolder>	getFolders(long groupId, long parentFolderId, int start, int end)
List<Object>	getFoldersAndFileEntriesAndFileShortcuts(long groupId, List<Long> folderIds, int status, int start, int end)
List<Object>	getFoldersAndFileEntriesAndFileShortcuts(long groupId, long folderId, int status, int start, int end)
int	getFoldersAndFileEntriesAndFileShortcutsCount(long groupId, List<Long> folderIds, int status)
int	getFoldersAndFileEntriesAndFileShortcutsCount(long groupId, long folderId, int status)
int	getFoldersCount(long groupId, long parentFolderId)
void	getSubfolderIds(List<Long> folderIds, long groupId, long folderId)
boolean	hasInheritableLock(long folderId)
Lock	lockFolder(long folderId)
Lock	lockFolder(long folderId, String owner, boolean inheritable, long expirationTime)
Lock	refreshFolderLock(String lockUuid, long expirationTime)
void	unlockFolder(long groupId, long folderId, String lockUuid)
void	unlockFolder(long groupId, long parentFolderId, String name, String lockUuid)
DLFolder	updateFolder(long folderId, long parentFolderId, String name, String description, ServiceContext serviceContext)
boolean	verifyInheritableLock(long folderId, String lockUuid)

Method Detail

addFolder

DLFolder addFolder(long groupId,
                   long parentFolderId,
                   String name,
                   String description,
                   ServiceContext serviceContext)
                   throws PortalException,
                          SystemException

Throws:

PortalException

SystemException

copyFolder

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

Throws:

PortalException

SystemException

RemoteException

deleteFolder

void deleteFolder(long folderId)
                  throws PortalException,
                         SystemException,
                         RemoteException

Throws:

PortalException

SystemException

RemoteException

deleteFolder

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

Throws:

PortalException

SystemException

RemoteException

getFileEntriesAndFileShortcuts

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

Throws:

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,
                                                                                 List<Long> folderIds,
                                                                                 int status)
                                        throws SystemException

Throws:

SystemException

getFileEntriesAndFileShortcutsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFileEntriesAndFileShortcutsCount(long groupId,
                                                                                 long folderId,
                                                                                 int status)
                                        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

getFolderId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long getFolderId(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)
                          throws SystemException

Throws:

SystemException

getFolders

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

Throws:

SystemException

getFoldersAndFileEntriesAndFileShortcuts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Object> getFoldersAndFileEntriesAndFileShortcuts(long groupId,
                                                                                               List<Long> folderIds,
                                                                                               int status,
                                                                                               int start,
                                                                                               int end)
                                                      throws SystemException

Throws:

SystemException

getFoldersAndFileEntriesAndFileShortcuts

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

Throws:

PortalException

SystemException

getFoldersAndFileEntriesAndFileShortcutsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
                                                                                           List<Long> folderIds,
                                                                                           int status)
                                                  throws SystemException

Throws:

SystemException

getFoldersAndFileEntriesAndFileShortcutsCount

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

Throws:

PortalException

SystemException

getFoldersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFoldersCount(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

hasInheritableLock

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

Throws:

PortalException

SystemException

lockFolder

Lock lockFolder(long folderId)
                throws PortalException,
                       SystemException,
                       RemoteException

Throws:

PortalException

SystemException

RemoteException

lockFolder

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

Throws:

PortalException

SystemException

RemoteException

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,
                      long parentFolderId,
                      String name,
                      String description,
                      ServiceContext serviceContext)
                      throws PortalException,
                             SystemException,
                             RemoteException

Throws:

PortalException

SystemException

RemoteException

verifyInheritableLock

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

Throws:

PortalException

SystemException