com.liferay.portlet.documentlibrary.service
Interface DLFileEntryService
- All Known Implementing Classes:
- DLFileEntryServiceWrapper
@JSONWebService
@Transactional(isolation=PORTAL,
rollbackFor={PortalException.class,SystemException.class})
public interface DLFileEntryService
The interface for the document library file entry remote service.
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.
- See Also:
DLFileEntryServiceUtil,
com.liferay.portlet.documentlibrary.service.base.DLFileEntryServiceBaseImpl,
com.liferay.portlet.documentlibrary.service.impl.DLFileEntryServiceImpl
|
Method Summary |
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)
|
void |
cancelCheckOut(long fileEntryId)
|
void |
checkInFileEntry(long fileEntryId,
boolean major,
String changeLog,
ServiceContext serviceContext)
|
void |
checkInFileEntry(long fileEntryId,
String lockUuid)
|
DLFileEntry |
checkOutFileEntry(long fileEntryId)
|
DLFileEntry |
checkOutFileEntry(long fileEntryId,
String owner,
long expirationTime)
|
DLFileEntry |
copyFileEntry(long groupId,
long repositoryId,
long fileEntryId,
long destFolderId,
ServiceContext serviceContext)
|
void |
deleteFileEntry(long fileEntryId)
|
void |
deleteFileEntry(long groupId,
long folderId,
String title)
|
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 start,
int end,
OrderByComparator obc)
|
List<DLFileEntry> |
getFileEntries(long groupId,
long folderId,
long fileEntryTypeId,
int start,
int end,
OrderByComparator obc)
|
int |
getFileEntriesCount(long groupId,
long folderId)
|
int |
getFileEntriesCount(long groupId,
long folderId,
long fileEntryTypeId)
|
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 obc)
|
int |
getGroupFileEntriesCount(long groupId,
long userId,
long rootFolderId)
|
boolean |
hasFileEntryLock(long fileEntryId)
|
boolean |
isFileEntryCheckedOut(long fileEntryId)
|
DLFileEntry |
moveFileEntry(long fileEntryId,
long newFolderId,
ServiceContext serviceContext)
|
Lock |
refreshFileEntryLock(String lockUuid,
long expirationTime)
|
void |
revertFileEntry(long fileEntryId,
String version,
ServiceContext serviceContext)
|
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)
|
boolean |
verifyFileEntryCheckOut(long fileEntryId,
String lockUuid)
|
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
void 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
- Throws:
PortalException
SystemException
checkOutFileEntry
DLFileEntry checkOutFileEntry(long fileEntryId)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
checkOutFileEntry
DLFileEntry checkOutFileEntry(long fileEntryId,
String owner,
long expirationTime)
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
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 start,
int end,
OrderByComparator obc)
throws SystemException
- Throws:
SystemException
getFileEntries
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<DLFileEntry> getFileEntries(long groupId,
long folderId,
long fileEntryTypeId,
int start,
int end,
OrderByComparator obc)
throws SystemException
- Throws:
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,
long fileEntryTypeId)
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 SystemException
- Throws:
SystemException
getGroupFileEntriesCount
@Transactional(propagation=SUPPORTS,
readOnly=true)
int getGroupFileEntriesCount(long groupId,
long userId,
long rootFolderId)
throws SystemException
- Throws:
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 expirationTime)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
revertFileEntry
void revertFileEntry(long fileEntryId,
String version,
ServiceContext serviceContext)
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