Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.liferay.portlet.documentlibrary.service
Interface DLFolderService

@Transactional(rollbackFor={com.liferay.portal.PortalException.class,com.liferay.portal.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

Method Summary
 DLFolder addFolder(long groupId, long parentFolderId, java.lang.String name, java.lang.String description, boolean addCommunityPermissions, boolean addGuestPermissions)
           
 DLFolder addFolder(long groupId, long parentFolderId, java.lang.String name, java.lang.String description, java.lang.String[] communityPermissions, java.lang.String[] guestPermissions)
           
 DLFolder copyFolder(long groupId, long sourceFolderId, long parentFolderId, java.lang.String name, java.lang.String description, boolean addCommunityPermissions, boolean addGuestPermissions)
           
 void deleteFolder(long folderId)
           
 void deleteFolder(long groupId, long parentFolderId, java.lang.String name)
           
 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)
           
 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 reIndexSearch(long companyId)
           
 void unlockFolder(long groupId, long parentFolderId, java.lang.String name, java.lang.String lockUuid)
           
 void unlockFolder(long folderId, java.lang.String lockUuid)
           
 DLFolder updateFolder(long folderId, long parentFolderId, java.lang.String name, java.lang.String description)
           
 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,
                   boolean addCommunityPermissions,
                   boolean addGuestPermissions)
                   throws com.liferay.portal.PortalException,
                          com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

addFolder

DLFolder addFolder(long groupId,
                   long parentFolderId,
                   java.lang.String name,
                   java.lang.String description,
                   java.lang.String[] communityPermissions,
                   java.lang.String[] guestPermissions)
                   throws com.liferay.portal.PortalException,
                          com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

copyFolder

DLFolder copyFolder(long groupId,
                    long sourceFolderId,
                    long parentFolderId,
                    java.lang.String name,
                    java.lang.String description,
                    boolean addCommunityPermissions,
                    boolean addGuestPermissions)
                    throws com.liferay.portal.PortalException,
                           com.liferay.portal.SystemException,
                           java.rmi.RemoteException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException
java.rmi.RemoteException

deleteFolder

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

deleteFolder

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

getFolder

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

getFolder

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFolder getFolder(long groupId,
                                 long parentFolderId,
                                 java.lang.String name)
                   throws com.liferay.portal.PortalException,
                          com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getFolderId

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

getFolders

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

hasInheritableLock

boolean hasInheritableLock(long folderId)
                           throws com.liferay.portal.PortalException
Throws:
com.liferay.portal.PortalException

lockFolder

Lock lockFolder(long folderId)
                throws com.liferay.portal.PortalException,
                       com.liferay.portal.SystemException,
                       java.rmi.RemoteException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException
java.rmi.RemoteException

lockFolder

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

refreshFolderLock

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

reIndexSearch

void reIndexSearch(long companyId)
                   throws com.liferay.portal.PortalException,
                          com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

unlockFolder

void unlockFolder(long folderId,
                  java.lang.String lockUuid)
                  throws com.liferay.portal.PortalException
Throws:
com.liferay.portal.PortalException

unlockFolder

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

updateFolder

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

verifyInheritableLock

boolean verifyInheritableLock(long folderId,
                              java.lang.String lockUuid)
                              throws com.liferay.portal.PortalException
Throws:
com.liferay.portal.PortalException
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD