com.liferay.document.library.kernel.service

Class DLFileEntryServiceWrapper

Object

com.liferay.document.library.kernel.service.DLFileEntryServiceWrapper

All Implemented Interfaces:

DLFileEntryService, BaseService, ServiceWrapper<DLFileEntryService>

@ProviderType
public class DLFileEntryServiceWrapper
extends Object
implements DLFileEntryService, ServiceWrapper<DLFileEntryService>

Provides a wrapper for DLFileEntryService.

Author:

Brian Wing Shun Chan

See Also:

DLFileEntryService

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
DLFileEntryServiceWrapper(DLFileEntryService dlFileEntryService)

Method Summary

Modifier and Type	Method and Description
DLFileEntry	addFileEntry(long groupId, long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String description, String changeLog, long fileEntryTypeId, Map<String,DDMFormValues> ddmFormValuesMap, File file, InputStream is, long size, ServiceContext serviceContext)
DLFileVersion	cancelCheckOut(long fileEntryId)
void	checkInFileEntry(long fileEntryId, boolean major, String changeLog, ServiceContext serviceContext)
void	checkInFileEntry(long fileEntryId, String lockUuid, ServiceContext serviceContext)
DLFileEntry	checkOutFileEntry(long fileEntryId, ServiceContext serviceContext)
DLFileEntry	checkOutFileEntry(long fileEntryId, String owner, long expirationTime, ServiceContext serviceContext)
DLFileEntry	copyFileEntry(long groupId, long repositoryId, long fileEntryId, long destFolderId, ServiceContext serviceContext)
void	deleteFileEntry(long fileEntryId)
void	deleteFileEntry(long groupId, long folderId, String title)
void	deleteFileVersion(long fileEntryId, String version)
DLFileEntry	fetchFileEntryByImageId(long imageId)
InputStream	getFileAsStream(long fileEntryId, String version)
InputStream	getFileAsStream(long fileEntryId, String version, boolean incrementCounter)
List<DLFileEntry>	getFileEntries(long groupId, long folderId, int status, int start, int end, OrderByComparator<DLFileEntry> obc)
List<DLFileEntry>	getFileEntries(long groupId, long folderId, int start, int end, OrderByComparator<DLFileEntry> obc)
List<DLFileEntry>	getFileEntries(long groupId, long folderId, long fileEntryTypeId, int start, int end, OrderByComparator<DLFileEntry> obc)
List<DLFileEntry>	getFileEntries(long groupId, long folderId, String[] mimeTypes, int start, int end, OrderByComparator<DLFileEntry> obc)
int	getFileEntriesCount(long groupId, long folderId)
int	getFileEntriesCount(long groupId, long folderId, int status)
int	getFileEntriesCount(long groupId, long folderId, long fileEntryTypeId)
int	getFileEntriesCount(long groupId, long folderId, String[] mimeTypes)
DLFileEntry	getFileEntry(long fileEntryId)
DLFileEntry	getFileEntry(long groupId, long folderId, String title)
DLFileEntry	getFileEntryByUuidAndGroupId(String uuid, long groupId)
Lock	getFileEntryLock(long fileEntryId)
int	getFoldersFileEntriesCount(long groupId, List<Long> folderIds, int status)
List<DLFileEntry>	getGroupFileEntries(long groupId, long userId, long rootFolderId, int start, int end, OrderByComparator<DLFileEntry> obc)
List<DLFileEntry>	getGroupFileEntries(long groupId, long userId, long repositoryId, long rootFolderId, String[] mimeTypes, int status, int start, int end, OrderByComparator<DLFileEntry> obc)
List<DLFileEntry>	getGroupFileEntries(long groupId, long userId, long rootFolderId, String[] mimeTypes, int status, int start, int end, OrderByComparator<DLFileEntry> obc)
int	getGroupFileEntriesCount(long groupId, long userId, long rootFolderId)
int	getGroupFileEntriesCount(long groupId, long userId, long repositoryId, long rootFolderId, String[] mimeTypes, int status)
int	getGroupFileEntriesCount(long groupId, long userId, long rootFolderId, String[] mimeTypes, int status)
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
DLFileEntryService	getWrappedService()
boolean	hasFileEntryLock(long fileEntryId)
boolean	isFileEntryCheckedOut(long fileEntryId)
boolean	isKeepFileVersionLabel(long fileEntryId, boolean majorVersion, ServiceContext serviceContext)
boolean	isKeepFileVersionLabel(long fileEntryId, ServiceContext serviceContext) Deprecated. As of Wilberforce (7.0.x), replaced by isKeepFileVersionLabel(long, boolean, ServiceContext)
DLFileEntry	moveFileEntry(long fileEntryId, long newFolderId, ServiceContext serviceContext)
Lock	refreshFileEntryLock(String lockUuid, long companyId, long expirationTime)
void	revertFileEntry(long fileEntryId, String version, ServiceContext serviceContext)
Hits	search(long groupId, long creatorUserId, int status, int start, int end)
Hits	search(long groupId, long creatorUserId, long folderId, String[] mimeTypes, int status, int start, int end)
void	setWrappedService(DLFileEntryService dlFileEntryService)
DLFileEntry	updateFileEntry(long fileEntryId, String sourceFileName, String mimeType, String title, String description, String changeLog, boolean majorVersion, long fileEntryTypeId, Map<String,DDMFormValues> ddmFormValuesMap, File file, InputStream is, long size, ServiceContext serviceContext)
DLFileEntry	updateStatus(long userId, long fileVersionId, int status, ServiceContext serviceContext, Map<String,Serializable> workflowContext)
boolean	verifyFileEntryCheckOut(long fileEntryId, String lockUuid)
boolean	verifyFileEntryLock(long fileEntryId, String lockUuid)

Methods inherited from class Object

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

Constructor Detail

DLFileEntryServiceWrapper

public DLFileEntryServiceWrapper(DLFileEntryService dlFileEntryService)

Method Detail

addFileEntry

public DLFileEntry addFileEntry(long groupId,
                                long repositoryId,
                                long folderId,
                                String sourceFileName,
                                String mimeType,
                                String title,
                                String description,
                                String changeLog,
                                long fileEntryTypeId,
                                Map<String,DDMFormValues> ddmFormValuesMap,
                                File file,
                                InputStream is,
                                long size,
                                ServiceContext serviceContext)
                         throws PortalException

Specified by:

addFileEntry in interface DLFileEntryService

Throws:

PortalException

cancelCheckOut

public DLFileVersion cancelCheckOut(long fileEntryId)
                             throws PortalException

Specified by:

cancelCheckOut in interface DLFileEntryService

Throws:

PortalException

checkInFileEntry

public void checkInFileEntry(long fileEntryId,
                             boolean major,
                             String changeLog,
                             ServiceContext serviceContext)
                      throws PortalException

Specified by:

checkInFileEntry in interface DLFileEntryService

Throws:

PortalException

checkInFileEntry

public void checkInFileEntry(long fileEntryId,
                             String lockUuid,
                             ServiceContext serviceContext)
                      throws PortalException

Specified by:

checkInFileEntry in interface DLFileEntryService

Throws:

PortalException

checkOutFileEntry

public DLFileEntry checkOutFileEntry(long fileEntryId,
                                     ServiceContext serviceContext)
                              throws PortalException

Specified by:

checkOutFileEntry in interface DLFileEntryService

Throws:

PortalException

checkOutFileEntry

public DLFileEntry checkOutFileEntry(long fileEntryId,
                                     String owner,
                                     long expirationTime,
                                     ServiceContext serviceContext)
                              throws PortalException

Specified by:

checkOutFileEntry in interface DLFileEntryService

Throws:

PortalException

copyFileEntry

public DLFileEntry copyFileEntry(long groupId,
                                 long repositoryId,
                                 long fileEntryId,
                                 long destFolderId,
                                 ServiceContext serviceContext)
                          throws PortalException

Specified by:

copyFileEntry in interface DLFileEntryService

Throws:

PortalException

deleteFileEntry

public void deleteFileEntry(long fileEntryId)
                     throws PortalException

Specified by:

deleteFileEntry in interface DLFileEntryService

Throws:

PortalException

deleteFileEntry

public void deleteFileEntry(long groupId,
                            long folderId,
                            String title)
                     throws PortalException

Specified by:

deleteFileEntry in interface DLFileEntryService

Throws:

PortalException

deleteFileVersion

public void deleteFileVersion(long fileEntryId,
                              String version)
                       throws PortalException

Specified by:

deleteFileVersion in interface DLFileEntryService

Throws:

PortalException

fetchFileEntryByImageId

public DLFileEntry fetchFileEntryByImageId(long imageId)
                                    throws PortalException

Specified by:

fetchFileEntryByImageId in interface DLFileEntryService

Throws:

PortalException

getFileAsStream

public InputStream getFileAsStream(long fileEntryId,
                                   String version)
                            throws PortalException

Specified by:

getFileAsStream in interface DLFileEntryService

Throws:

PortalException

getFileAsStream

public InputStream getFileAsStream(long fileEntryId,
                                   String version,
                                   boolean incrementCounter)
                            throws PortalException

Specified by:

getFileAsStream in interface DLFileEntryService

Throws:

PortalException

getFileEntries

public List<DLFileEntry> getFileEntries(long groupId,
                                        long folderId,
                                        int status,
                                        int start,
                                        int end,
                                        OrderByComparator<DLFileEntry> obc)
                                 throws PortalException

Specified by:

getFileEntries in interface DLFileEntryService

Throws:

PortalException

getFileEntries

public List<DLFileEntry> getFileEntries(long groupId,
                                        long folderId,
                                        int start,
                                        int end,
                                        OrderByComparator<DLFileEntry> obc)
                                 throws PortalException

Specified by:

getFileEntries in interface DLFileEntryService

Throws:

PortalException

getFileEntries

public List<DLFileEntry> getFileEntries(long groupId,
                                        long folderId,
                                        long fileEntryTypeId,
                                        int start,
                                        int end,
                                        OrderByComparator<DLFileEntry> obc)
                                 throws PortalException

Specified by:

getFileEntries in interface DLFileEntryService

Throws:

PortalException

getFileEntries

public List<DLFileEntry> getFileEntries(long groupId,
                                        long folderId,
                                        String[] mimeTypes,
                                        int start,
                                        int end,
                                        OrderByComparator<DLFileEntry> obc)
                                 throws PortalException

Specified by:

getFileEntries in interface DLFileEntryService

Throws:

PortalException

getFileEntriesCount

public int getFileEntriesCount(long groupId,
                               long folderId)

Specified by:

getFileEntriesCount in interface DLFileEntryService

getFileEntriesCount

public int getFileEntriesCount(long groupId,
                               long folderId,
                               int status)

Specified by:

getFileEntriesCount in interface DLFileEntryService

getFileEntriesCount

public int getFileEntriesCount(long groupId,
                               long folderId,
                               long fileEntryTypeId)

Specified by:

getFileEntriesCount in interface DLFileEntryService

getFileEntriesCount

public int getFileEntriesCount(long groupId,
                               long folderId,
                               String[] mimeTypes)

Specified by:

getFileEntriesCount in interface DLFileEntryService

getFileEntry

public DLFileEntry getFileEntry(long fileEntryId)
                         throws PortalException

Specified by:

getFileEntry in interface DLFileEntryService

Throws:

PortalException

getFileEntry

public DLFileEntry getFileEntry(long groupId,
                                long folderId,
                                String title)
                         throws PortalException

Specified by:

getFileEntry in interface DLFileEntryService

Throws:

PortalException

getFileEntryByUuidAndGroupId

public DLFileEntry getFileEntryByUuidAndGroupId(String uuid,
                                                long groupId)
                                         throws PortalException

Specified by:

getFileEntryByUuidAndGroupId in interface DLFileEntryService

Throws:

PortalException

getFileEntryLock

public Lock getFileEntryLock(long fileEntryId)

Specified by:

getFileEntryLock in interface DLFileEntryService

getFoldersFileEntriesCount

public int getFoldersFileEntriesCount(long groupId,
                                      List<Long> folderIds,
                                      int status)

Specified by:

getFoldersFileEntriesCount in interface DLFileEntryService

getGroupFileEntries

public List<DLFileEntry> getGroupFileEntries(long groupId,
                                             long userId,
                                             long rootFolderId,
                                             int start,
                                             int end,
                                             OrderByComparator<DLFileEntry> obc)
                                      throws PortalException

Specified by:

getGroupFileEntries in interface DLFileEntryService

Throws:

PortalException

getGroupFileEntries

public List<DLFileEntry> getGroupFileEntries(long groupId,
                                             long userId,
                                             long repositoryId,
                                             long rootFolderId,
                                             String[] mimeTypes,
                                             int status,
                                             int start,
                                             int end,
                                             OrderByComparator<DLFileEntry> obc)
                                      throws PortalException

Specified by:

getGroupFileEntries in interface DLFileEntryService

Throws:

PortalException

getGroupFileEntries

public List<DLFileEntry> getGroupFileEntries(long groupId,
                                             long userId,
                                             long rootFolderId,
                                             String[] mimeTypes,
                                             int status,
                                             int start,
                                             int end,
                                             OrderByComparator<DLFileEntry> obc)
                                      throws PortalException

Specified by:

getGroupFileEntries in interface DLFileEntryService

Throws:

PortalException

getGroupFileEntriesCount

public int getGroupFileEntriesCount(long groupId,
                                    long userId,
                                    long rootFolderId)
                             throws PortalException

Specified by:

getGroupFileEntriesCount in interface DLFileEntryService

Throws:

PortalException

getGroupFileEntriesCount

public int getGroupFileEntriesCount(long groupId,
                                    long userId,
                                    long repositoryId,
                                    long rootFolderId,
                                    String[] mimeTypes,
                                    int status)
                             throws PortalException

Specified by:

getGroupFileEntriesCount in interface DLFileEntryService

Throws:

PortalException

getGroupFileEntriesCount

public int getGroupFileEntriesCount(long groupId,
                                    long userId,
                                    long rootFolderId,
                                    String[] mimeTypes,
                                    int status)
                             throws PortalException

Specified by:

getGroupFileEntriesCount in interface DLFileEntryService

Throws:

PortalException

getOSGiServiceIdentifier

public String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Specified by:

getOSGiServiceIdentifier in interface DLFileEntryService

Returns:

the OSGi service identifier

hasFileEntryLock

public boolean hasFileEntryLock(long fileEntryId)
                         throws PortalException

Specified by:

hasFileEntryLock in interface DLFileEntryService

Throws:

PortalException

isFileEntryCheckedOut

public boolean isFileEntryCheckedOut(long fileEntryId)
                              throws PortalException

Specified by:

isFileEntryCheckedOut in interface DLFileEntryService

Throws:

PortalException

isKeepFileVersionLabel

public boolean isKeepFileVersionLabel(long fileEntryId,
                                      boolean majorVersion,
                                      ServiceContext serviceContext)
                               throws PortalException

Specified by:

isKeepFileVersionLabel in interface DLFileEntryService

Throws:

PortalException

isKeepFileVersionLabel

@Deprecated
public boolean isKeepFileVersionLabel(long fileEntryId,
                                                  ServiceContext serviceContext)
                                           throws PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by isKeepFileVersionLabel(long, boolean, ServiceContext)

Specified by:

isKeepFileVersionLabel in interface DLFileEntryService

Throws:

PortalException

moveFileEntry

public DLFileEntry moveFileEntry(long fileEntryId,
                                 long newFolderId,
                                 ServiceContext serviceContext)
                          throws PortalException

Specified by:

moveFileEntry in interface DLFileEntryService

Throws:

PortalException

refreshFileEntryLock

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

Specified by:

refreshFileEntryLock in interface DLFileEntryService

Throws:

PortalException

revertFileEntry

public void revertFileEntry(long fileEntryId,
                            String version,
                            ServiceContext serviceContext)
                     throws PortalException

Specified by:

revertFileEntry in interface DLFileEntryService

Throws:

PortalException

search

public Hits search(long groupId,
                   long creatorUserId,
                   int status,
                   int start,
                   int end)
            throws PortalException

Specified by:

search in interface DLFileEntryService

Throws:

PortalException

search

public Hits search(long groupId,
                   long creatorUserId,
                   long folderId,
                   String[] mimeTypes,
                   int status,
                   int start,
                   int end)
            throws PortalException

Specified by:

search in interface DLFileEntryService

Throws:

PortalException

updateFileEntry

public DLFileEntry updateFileEntry(long fileEntryId,
                                   String sourceFileName,
                                   String mimeType,
                                   String title,
                                   String description,
                                   String changeLog,
                                   boolean majorVersion,
                                   long fileEntryTypeId,
                                   Map<String,DDMFormValues> ddmFormValuesMap,
                                   File file,
                                   InputStream is,
                                   long size,
                                   ServiceContext serviceContext)
                            throws PortalException

Specified by:

updateFileEntry in interface DLFileEntryService

Throws:

PortalException

updateStatus

public DLFileEntry updateStatus(long userId,
                                long fileVersionId,
                                int status,
                                ServiceContext serviceContext,
                                Map<String,Serializable> workflowContext)
                         throws PortalException

Specified by:

updateStatus in interface DLFileEntryService

Throws:

PortalException

verifyFileEntryCheckOut

public boolean verifyFileEntryCheckOut(long fileEntryId,
                                       String lockUuid)
                                throws PortalException

Specified by:

verifyFileEntryCheckOut in interface DLFileEntryService

Throws:

PortalException

verifyFileEntryLock

public boolean verifyFileEntryLock(long fileEntryId,
                                   String lockUuid)
                            throws PortalException

Specified by:

verifyFileEntryLock in interface DLFileEntryService

Throws:

PortalException

getWrappedService

public DLFileEntryService getWrappedService()

Specified by:

getWrappedService in interface ServiceWrapper<DLFileEntryService>

setWrappedService

public void setWrappedService(DLFileEntryService dlFileEntryService)

Specified by:

setWrappedService in interface ServiceWrapper<DLFileEntryService>