com.liferay.document.library.kernel.service

Class DLFolderServiceWrapper

Object

com.liferay.document.library.kernel.service.DLFolderServiceWrapper

All Implemented Interfaces:

DLFolderService, BaseService, ServiceWrapper<DLFolderService>

@ProviderType
public class DLFolderServiceWrapper
extends Object
implements DLFolderService, ServiceWrapper<DLFolderService>

Provides a wrapper for DLFolderService.

Author:

Brian Wing Shun Chan

See Also:

DLFolderService

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
DLFolderServiceWrapper(DLFolderService dlFolderService)

Method Summary

Modifier and Type	Method and Description
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	getFoldersAndFileEntriesAndFileShortcutsCount(long groupId, long folderId, String[] mimeTypes, boolean includeMountFolders, QueryDefinition<?> queryDefinition)
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)
DLFolderService	getWrappedService()
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	setWrappedService(DLFolderService dlFolderService)
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)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DLFolderServiceWrapper

public DLFolderServiceWrapper(DLFolderService dlFolderService)

Method Detail

addFolder

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

Specified by:

addFolder in interface DLFolderService

Throws:

PortalException

deleteFolder

public void deleteFolder(long folderId)
                  throws PortalException

Specified by:

deleteFolder in interface DLFolderService

Throws:

PortalException

deleteFolder

public void deleteFolder(long folderId,
                         boolean includeTrashedEntries)
                  throws PortalException

Specified by:

deleteFolder in interface DLFolderService

Throws:

PortalException

deleteFolder

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

Specified by:

deleteFolder in interface DLFolderService

Throws:

PortalException

getFileEntriesAndFileShortcuts

public List<Object> getFileEntriesAndFileShortcuts(long groupId,
                                                   long folderId,
                                                   int status,
                                                   int start,
                                                   int end)
                                            throws PortalException

Specified by:

getFileEntriesAndFileShortcuts in interface DLFolderService

Throws:

PortalException

getFileEntriesAndFileShortcutsCount

public int getFileEntriesAndFileShortcutsCount(long groupId,
                                               long folderId,
                                               int status)
                                        throws PortalException

Specified by:

getFileEntriesAndFileShortcutsCount in interface DLFolderService

Throws:

PortalException

getFileEntriesAndFileShortcutsCount

public int getFileEntriesAndFileShortcutsCount(long groupId,
                                               long folderId,
                                               int status,
                                               String[] mimeTypes)
                                        throws PortalException

Specified by:

getFileEntriesAndFileShortcutsCount in interface DLFolderService

Throws:

PortalException

getFolder

public DLFolder getFolder(long folderId)
                   throws PortalException

Specified by:

getFolder in interface DLFolderService

Throws:

PortalException

getFolder

public DLFolder getFolder(long groupId,
                          long parentFolderId,
                          String name)
                   throws PortalException

Specified by:

getFolder in interface DLFolderService

Throws:

PortalException

getFolderIds

public List<Long> getFolderIds(long groupId,
                               long folderId)
                        throws PortalException

Specified by:

getFolderIds in interface DLFolderService

Throws:

PortalException

getFolders

public List<DLFolder> getFolders(long groupId,
                                 long parentFolderId,
                                 int status,
                                 boolean includeMountfolders,
                                 int start,
                                 int end,
                                 OrderByComparator<DLFolder> obc)
                          throws PortalException

Specified by:

getFolders in interface DLFolderService

Throws:

PortalException

getFolders

public List<DLFolder> getFolders(long groupId,
                                 long parentFolderId,
                                 int start,
                                 int end,
                                 OrderByComparator<DLFolder> obc)
                          throws PortalException

Specified by:

getFolders in interface DLFolderService

Throws:

PortalException

getFoldersAndFileEntriesAndFileShortcuts

public List<Object> getFoldersAndFileEntriesAndFileShortcuts(long groupId,
                                                             long folderId,
                                                             int status,
                                                             boolean includeMountFolders,
                                                             int start,
                                                             int end,
                                                             OrderByComparator<?> obc)
                                                      throws PortalException

Specified by:

getFoldersAndFileEntriesAndFileShortcuts in interface DLFolderService

Throws:

PortalException

getFoldersAndFileEntriesAndFileShortcuts

public List<Object> getFoldersAndFileEntriesAndFileShortcuts(long groupId,
                                                             long folderId,
                                                             int status,
                                                             String[] mimeTypes,
                                                             boolean includeMountFolders,
                                                             int start,
                                                             int end,
                                                             OrderByComparator<?> obc)
                                                      throws PortalException

Specified by:

getFoldersAndFileEntriesAndFileShortcuts in interface DLFolderService

Throws:

PortalException

getFoldersAndFileEntriesAndFileShortcuts

public List<Object> getFoldersAndFileEntriesAndFileShortcuts(long groupId,
                                                             long folderId,
                                                             String[] mimeTypes,
                                                             boolean includeMountFolders,
                                                             QueryDefinition<?> queryDefinition)
                                                      throws PortalException

Specified by:

getFoldersAndFileEntriesAndFileShortcuts in interface DLFolderService

Throws:

PortalException

getFoldersAndFileEntriesAndFileShortcutsCount

public int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
                                                         long folderId,
                                                         int status,
                                                         boolean includeMountFolders)
                                                  throws PortalException

Specified by:

getFoldersAndFileEntriesAndFileShortcutsCount in interface DLFolderService

Throws:

PortalException

getFoldersAndFileEntriesAndFileShortcutsCount

public int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
                                                         long folderId,
                                                         int status,
                                                         String[] mimeTypes,
                                                         boolean includeMountFolders)
                                                  throws PortalException

Specified by:

getFoldersAndFileEntriesAndFileShortcutsCount in interface DLFolderService

Throws:

PortalException

getFoldersAndFileEntriesAndFileShortcutsCount

public int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
                                                         long folderId,
                                                         String[] mimeTypes,
                                                         boolean includeMountFolders,
                                                         QueryDefinition<?> queryDefinition)
                                                  throws PortalException

Specified by:

getFoldersAndFileEntriesAndFileShortcutsCount in interface DLFolderService

Throws:

PortalException

getFoldersCount

public int getFoldersCount(long groupId,
                           long parentFolderId)
                    throws PortalException

Specified by:

getFoldersCount in interface DLFolderService

Throws:

PortalException

getFoldersCount

public int getFoldersCount(long groupId,
                           long parentFolderId,
                           int status,
                           boolean includeMountfolders)
                    throws PortalException

Specified by:

getFoldersCount in interface DLFolderService

Throws:

PortalException

getMountFolders

public List<DLFolder> getMountFolders(long groupId,
                                      long parentFolderId,
                                      int start,
                                      int end,
                                      OrderByComparator<DLFolder> obc)
                               throws PortalException

Specified by:

getMountFolders in interface DLFolderService

Throws:

PortalException

getMountFoldersCount

public int getMountFoldersCount(long groupId,
                                long parentFolderId)
                         throws PortalException

Specified by:

getMountFoldersCount in interface DLFolderService

Throws:

PortalException

getOSGiServiceIdentifier

public String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Specified by:

getOSGiServiceIdentifier in interface DLFolderService

Returns:

the OSGi service identifier

getSubfolderIds

@Deprecated
public void getSubfolderIds(List<Long> folderIds,
                                        long groupId,
                                        long folderId)
                                 throws PortalException

Deprecated. As of 7.0.0, replaced by getSubfolderIds(List, long, long, boolean)

Specified by:

getSubfolderIds in interface DLFolderService

Throws:

PortalException

getSubfolderIds

public void getSubfolderIds(List<Long> folderIds,
                            long groupId,
                            long folderId,
                            boolean recurse)
                     throws PortalException

Specified by:

getSubfolderIds in interface DLFolderService

Throws:

PortalException

getSubfolderIds

public List<Long> getSubfolderIds(long groupId,
                                  long folderId,
                                  boolean recurse)
                           throws PortalException

Specified by:

getSubfolderIds in interface DLFolderService

Throws:

PortalException

hasFolderLock

public boolean hasFolderLock(long folderId)
                      throws PortalException

Specified by:

hasFolderLock in interface DLFolderService

Throws:

PortalException

hasInheritableLock

public boolean hasInheritableLock(long folderId)
                           throws PortalException

Specified by:

hasInheritableLock in interface DLFolderService

Throws:

PortalException

isFolderLocked

public boolean isFolderLocked(long folderId)

Specified by:

isFolderLocked in interface DLFolderService

lockFolder

public Lock lockFolder(long folderId)
                throws PortalException

Specified by:

lockFolder in interface DLFolderService

Throws:

PortalException

lockFolder

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

Specified by:

lockFolder in interface DLFolderService

Throws:

PortalException

moveFolder

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

Specified by:

moveFolder in interface DLFolderService

Throws:

PortalException

refreshFolderLock

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

Specified by:

refreshFolderLock in interface DLFolderService

Throws:

PortalException

unlockFolder

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

Specified by:

unlockFolder in interface DLFolderService

Throws:

PortalException

unlockFolder

public void unlockFolder(long folderId,
                         String lockUuid)
                  throws PortalException

Specified by:

unlockFolder in interface DLFolderService

Throws:

PortalException

updateFolder

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

Specified by:

updateFolder in interface DLFolderService

Throws:

PortalException

updateFolder

@Deprecated
public 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)

Specified by:

updateFolder in interface DLFolderService

Throws:

PortalException

updateFolder

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

Specified by:

updateFolder in interface DLFolderService

Throws:

PortalException

verifyInheritableLock

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

Specified by:

verifyInheritableLock in interface DLFolderService

Throws:

PortalException

getWrappedService

public DLFolderService getWrappedService()

Specified by:

getWrappedService in interface ServiceWrapper<DLFolderService>

setWrappedService

public void setWrappedService(DLFolderService dlFolderService)

Specified by:

setWrappedService in interface ServiceWrapper<DLFolderService>