com.liferay.portlet.documentlibrary.service
Interface DLFileEntryService

All Superinterfaces:

BaseService

All Known Implementing Classes:

DLFileEntryServiceBaseImpl, DLFileEntryServiceImpl, DLFileEntryServiceWrapper

@ProviderType
@AccessControlled
@JSONWebService
@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface DLFileEntryService
extends BaseService

Provides the remote service interface for DLFileEntry. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.

See Also:

DLFileEntryServiceUtil, DLFileEntryServiceBaseImpl, DLFileEntryServiceImpl

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

Method Summary

abstract DLFileEntry	addFileEntry(long groupId, long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String description, String changeLog, long fileEntryTypeId, Map<String,Fields> fieldsMap, File file, InputStream is, long size, ServiceContext serviceContext)
abstract DLFileVersion	cancelCheckOut(long fileEntryId)
abstract void	checkInFileEntry(long fileEntryId, boolean major, String changeLog, ServiceContext serviceContext)
abstract void	checkInFileEntry(long fileEntryId, String lockUuid) Deprecated. As of 6.2.0, replaced by checkInFileEntry(long, String, ServiceContext)
abstract void	checkInFileEntry(long fileEntryId, String lockUuid, ServiceContext serviceContext)
abstract DLFileEntry	checkOutFileEntry(long fileEntryId) Deprecated. As of 6.2.0, replaced by checkOutFileEntry(long, ServiceContext)
abstract DLFileEntry	checkOutFileEntry(long fileEntryId, ServiceContext serviceContext)
abstract DLFileEntry	checkOutFileEntry(long fileEntryId, String owner, long expirationTime) Deprecated. As of 6.2.0, replaced by checkOutFileEntry(long, String, long, ServiceContext)
abstract DLFileEntry	checkOutFileEntry(long fileEntryId, String owner, long expirationTime, ServiceContext serviceContext)
abstract DLFileEntry	copyFileEntry(long groupId, long repositoryId, long fileEntryId, long destFolderId, ServiceContext serviceContext)
abstract void	deleteFileEntry(long fileEntryId)
abstract void	deleteFileEntry(long groupId, long folderId, String title)
abstract void	deleteFileVersion(long fileEntryId, String version)
abstract DLFileEntry	fetchFileEntryByImageId(long imageId)
abstract String	getBeanIdentifier() Returns the Spring bean ID for this bean.
abstract InputStream	getFileAsStream(long fileEntryId, String version)
abstract InputStream	getFileAsStream(long fileEntryId, String version, boolean incrementCounter)
abstract List<DLFileEntry>	getFileEntries(long groupId, long folderId, int status, int start, int end, OrderByComparator obc)
abstract List<DLFileEntry>	getFileEntries(long groupId, long folderId, int start, int end, OrderByComparator obc)
abstract List<DLFileEntry>	getFileEntries(long groupId, long folderId, long fileEntryTypeId, int start, int end, OrderByComparator obc)
abstract List<DLFileEntry>	getFileEntries(long groupId, long folderId, String[] mimeTypes, int start, int end, OrderByComparator obc)
abstract int	getFileEntriesCount(long groupId, long folderId)
abstract int	getFileEntriesCount(long groupId, long folderId, int status)
abstract int	getFileEntriesCount(long groupId, long folderId, long fileEntryTypeId)
abstract int	getFileEntriesCount(long groupId, long folderId, String[] mimeTypes)
abstract DLFileEntry	getFileEntry(long fileEntryId)
abstract DLFileEntry	getFileEntry(long groupId, long folderId, String title)
abstract DLFileEntry	getFileEntryByUuidAndGroupId(String uuid, long groupId)
abstract Lock	getFileEntryLock(long fileEntryId)
abstract int	getFoldersFileEntriesCount(long groupId, List<Long> folderIds, int status)
abstract List<DLFileEntry>	getGroupFileEntries(long groupId, long userId, long rootFolderId, int start, int end, OrderByComparator obc)
abstract List<DLFileEntry>	getGroupFileEntries(long groupId, long userId, long rootFolderId, String[] mimeTypes, int status, int start, int end, OrderByComparator obc)
abstract int	getGroupFileEntriesCount(long groupId, long userId, long rootFolderId)
abstract int	getGroupFileEntriesCount(long groupId, long userId, long rootFolderId, String[] mimeTypes, int status)
abstract boolean	hasFileEntryLock(long fileEntryId)
abstract boolean	isFileEntryCheckedOut(long fileEntryId)
abstract DLFileEntry	moveFileEntry(long fileEntryId, long newFolderId, ServiceContext serviceContext)
abstract Lock	refreshFileEntryLock(String lockUuid, long companyId, long expirationTime)
abstract void	revertFileEntry(long fileEntryId, String version, ServiceContext serviceContext)
abstract Hits	search(long groupId, long creatorUserId, int status, int start, int end)
abstract Hits	search(long groupId, long creatorUserId, long folderId, String[] mimeTypes, int status, int start, int end)
abstract void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
abstract DLFileEntry	updateFileEntry(long fileEntryId, String sourceFileName, String mimeType, String title, String description, String changeLog, boolean majorVersion, long fileEntryTypeId, Map<String,Fields> fieldsMap, File file, InputStream is, long size, ServiceContext serviceContext)
abstract boolean	verifyFileEntryCheckOut(long fileEntryId, String lockUuid)
abstract boolean	verifyFileEntryLock(long fileEntryId, String lockUuid)

Method Detail

getBeanIdentifier

String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addFileEntry

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

Throws:

PortalException

SystemException

cancelCheckOut

DLFileVersion cancelCheckOut(long fileEntryId)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

checkInFileEntry

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

Throws:

PortalException

SystemException

checkInFileEntry

void checkInFileEntry(long fileEntryId,
                      String lockUuid)
                      throws PortalException,
                             SystemException

Deprecated. As of 6.2.0, replaced by checkInFileEntry(long, String, ServiceContext)

Throws:

PortalException

SystemException

checkInFileEntry

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

Throws:

PortalException

SystemException

checkOutFileEntry

DLFileEntry checkOutFileEntry(long fileEntryId)
                              throws PortalException,
                                     SystemException

Deprecated. As of 6.2.0, replaced by checkOutFileEntry(long, ServiceContext)

Throws:

PortalException

SystemException

checkOutFileEntry

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

Throws:

PortalException

SystemException

checkOutFileEntry

DLFileEntry checkOutFileEntry(long fileEntryId,
                              String owner,
                              long expirationTime)
                              throws PortalException,
                                     SystemException

Deprecated. As of 6.2.0, replaced by checkOutFileEntry(long, String, long, ServiceContext)

Throws:

PortalException

SystemException

checkOutFileEntry

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

Throws:

PortalException

SystemException

copyFileEntry

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

Throws:

PortalException

SystemException

deleteFileEntry

void deleteFileEntry(long fileEntryId)
                     throws PortalException,
                            SystemException

Throws:

PortalException

SystemException

deleteFileEntry

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

Throws:

PortalException

SystemException

deleteFileVersion

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

Throws:

PortalException

SystemException

fetchFileEntryByImageId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileEntry fetchFileEntryByImageId(long imageId)
                                    throws PortalException,
                                           SystemException

Throws:

PortalException

SystemException

getFileAsStream

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

Throws:

PortalException

SystemException

getFileAsStream

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

Throws:

PortalException

SystemException

getFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getFileEntries(long groupId,
                                                                          long folderId,
                                                                          int status,
                                                                          int start,
                                                                          int end,
                                                                          OrderByComparator obc)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

getFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getFileEntries(long groupId,
                                                                          long folderId,
                                                                          int start,
                                                                          int end,
                                                                          OrderByComparator obc)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

getFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getFileEntries(long groupId,
                                                                          long folderId,
                                                                          long fileEntryTypeId,
                                                                          int start,
                                                                          int end,
                                                                          OrderByComparator obc)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

getFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getFileEntries(long groupId,
                                                                          long folderId,
                                                                          String[] mimeTypes,
                                                                          int start,
                                                                          int end,
                                                                          OrderByComparator obc)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

getFileEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFileEntriesCount(long groupId,
                                                                 long folderId)
                        throws SystemException

Throws:

SystemException

getFileEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFileEntriesCount(long groupId,
                                                                 long folderId,
                                                                 int status)
                        throws SystemException

Throws:

SystemException

getFileEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFileEntriesCount(long groupId,
                                                                 long folderId,
                                                                 long fileEntryTypeId)
                        throws SystemException

Throws:

SystemException

getFileEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFileEntriesCount(long groupId,
                                                                 long folderId,
                                                                 String[] mimeTypes)
                        throws SystemException

Throws:

SystemException

getFileEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileEntry getFileEntry(long fileEntryId)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

getFileEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileEntry getFileEntry(long groupId,
                                                                  long folderId,
                                                                  String title)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

getFileEntryByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileEntry getFileEntryByUuidAndGroupId(String uuid,
                                                                                  long groupId)
                                         throws PortalException,
                                                SystemException

Throws:

PortalException

SystemException

getFileEntryLock

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Lock getFileEntryLock(long fileEntryId)

getFoldersFileEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFoldersFileEntriesCount(long groupId,
                                                                        List<Long> folderIds,
                                                                        int status)
                               throws SystemException

Throws:

SystemException

getGroupFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getGroupFileEntries(long groupId,
                                                                               long userId,
                                                                               long rootFolderId,
                                                                               int start,
                                                                               int end,
                                                                               OrderByComparator obc)
                                      throws PortalException,
                                             SystemException

Throws:

PortalException

SystemException

getGroupFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getGroupFileEntries(long groupId,
                                                                               long userId,
                                                                               long rootFolderId,
                                                                               String[] mimeTypes,
                                                                               int status,
                                                                               int start,
                                                                               int end,
                                                                               OrderByComparator obc)
                                      throws PortalException,
                                             SystemException

Throws:

PortalException

SystemException

getGroupFileEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getGroupFileEntriesCount(long groupId,
                                                                      long userId,
                                                                      long rootFolderId)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

getGroupFileEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getGroupFileEntriesCount(long groupId,
                                                                      long userId,
                                                                      long rootFolderId,
                                                                      String[] mimeTypes,
                                                                      int status)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

hasFileEntryLock

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasFileEntryLock(long fileEntryId)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

isFileEntryCheckedOut

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean isFileEntryCheckedOut(long fileEntryId)
                              throws PortalException,
                                     SystemException

Throws:

PortalException

SystemException

moveFileEntry

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

Throws:

PortalException

SystemException

refreshFileEntryLock

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

Throws:

PortalException

SystemException

revertFileEntry

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

Throws:

PortalException

SystemException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Hits search(long groupId,
                                                     long creatorUserId,
                                                     int status,
                                                     int start,
                                                     int end)
            throws PortalException,
                   SystemException

Throws:

PortalException

SystemException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Hits search(long groupId,
                                                     long creatorUserId,
                                                     long folderId,
                                                     String[] mimeTypes,
                                                     int status,
                                                     int start,
                                                     int end)
            throws PortalException,
                   SystemException

Throws:

PortalException

SystemException

updateFileEntry

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

Throws:

PortalException

SystemException

verifyFileEntryCheckOut

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

Throws:

PortalException

SystemException

verifyFileEntryLock

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

Throws:

PortalException

SystemException