com.liferay.portlet.documentlibrary.service
Interface DLFolderService


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:
DLFolderServiceFactory, DLFolderServiceUtil

Method Summary
 DLFolder addFolder(long plid, long parentFolderId, java.lang.String name, java.lang.String description, boolean addCommunityPermissions, boolean addGuestPermissions)
           
 DLFolder addFolder(long plid, long parentFolderId, java.lang.String name, java.lang.String description, java.lang.String[] communityPermissions, java.lang.String[] guestPermissions)
           
 DLFolder copyFolder(long plid, 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)
           
 void reIndexSearch(long companyId)
           
 DLFolder updateFolder(long folderId, long parentFolderId, java.lang.String name, java.lang.String description)
           
 

Method Detail

addFolder

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

addFolder

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

copyFolder

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

deleteFolder

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

deleteFolder

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

getFolder

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

getFolder

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

getFolderId

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

getFolders

java.util.List<DLFolder> getFolders(long groupId,
                                    long parentFolderId)
                                    throws java.rmi.RemoteException,
                                           com.liferay.portal.SystemException,
                                           com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

reIndexSearch

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

updateFolder

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