com.liferay.portlet.documentlibrary.service
Interface DLFolderService

All Known Implementing Classes:
DLFolderServiceWrapper

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

View Source

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

This interface defines the service. The default implementation is com.liferay.portlet.documentlibrary.service.impl.DLFolderServiceImpl}. Modify methods in that class and rerun ServiceBuilder to populate this class and all other generated classes.

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.

Author:
Brian Wing Shun Chan
See Also:
DLFolderServiceUtil
Generated:

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

Method Detail

addFolder

DLFolder addFolder(long groupId,
                   long parentFolderId,
                   java.lang.String name,
                   java.lang.String description,
                   ServiceContext serviceContext)
                   throws PortalException,
                          SystemException
Throws:
PortalException
SystemException

copyFolder

DLFolder copyFolder(long groupId,
                    long sourceFolderId,
                    long parentFolderId,
                    java.lang.String name,
                    java.lang.String description,
                    ServiceContext serviceContext)
                    throws PortalException,
                           SystemException,
                           java.rmi.RemoteException
Throws:
PortalException
SystemException
java.rmi.RemoteException

deleteFolder

void deleteFolder(long folderId)
                  throws PortalException,
                         SystemException,
                         java.rmi.RemoteException
Throws:
PortalException
SystemException
java.rmi.RemoteException

deleteFolder

void deleteFolder(long groupId,
                  long parentFolderId,
                  java.lang.String name)
                  throws PortalException,
                         SystemException,
                         java.rmi.RemoteException
Throws:
PortalException
SystemException
java.rmi.RemoteException

getFileEntriesAndFileShortcuts

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

getFileEntriesAndFileShortcuts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<java.lang.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,
                                                                                 java.util.List<java.lang.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,
                                                            java.lang.String name)
                   throws PortalException,
                          SystemException
Throws:
PortalException
SystemException

getFolderId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long getFolderId(long groupId,
                                                          long parentFolderId,
                                                          java.lang.String name)
                 throws PortalException,
                        SystemException
Throws:
PortalException
SystemException

getFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DLFolder> getFolders(long groupId,
                                                                             long parentFolderId)
                                    throws SystemException
Throws:
SystemException

getFolders

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

getFoldersAndFileEntriesAndFileShortcuts

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

getFoldersAndFileEntriesAndFileShortcuts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<java.lang.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,
                                                                                           java.util.List<java.lang.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(java.util.List<java.lang.Long> folderIds,
                                                              long groupId,
                                                              long folderId)
                     throws PortalException,
                            SystemException
Throws:
PortalException
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,
                       java.rmi.RemoteException
Throws:
PortalException
SystemException
java.rmi.RemoteException

lockFolder

Lock lockFolder(long folderId,
                java.lang.String owner,
                boolean inheritable,
                long expirationTime)
                throws PortalException,
                       SystemException,
                       java.rmi.RemoteException
Throws:
PortalException
SystemException
java.rmi.RemoteException

refreshFolderLock

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

unlockFolder

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

unlockFolder

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

updateFolder

DLFolder updateFolder(long folderId,
                      long parentFolderId,
                      java.lang.String name,
                      java.lang.String description,
                      ServiceContext serviceContext)
                      throws PortalException,
                             SystemException,
                             java.rmi.RemoteException
Throws:
PortalException
SystemException
java.rmi.RemoteException

verifyInheritableLock

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