Interface DLFileEntryService
- All Superinterfaces:
BaseService
- All Known Implementing Classes:
DLFileEntryServiceWrapper
@AccessControlled
@CTAware
@JSONWebService
@ProviderType
@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.
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionaddFileEntry
(String externalReferenceCode, long groupId, long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, long fileEntryTypeId, Map<String, DDMFormValues> ddmFormValuesMap, File file, InputStream inputStream, long size, Date displayDate, Date expirationDate, Date reviewDate, ServiceContext serviceContext) cancelCheckOut
(long fileEntryId) void
checkInFileEntry
(long fileEntryId, DLVersionNumberIncrease dlVersionNumberIncrease, String changeLog, ServiceContext serviceContext) void
checkInFileEntry
(long fileEntryId, String lockUuid, ServiceContext serviceContext) checkOutFileEntry
(long fileEntryId, ServiceContext serviceContext) checkOutFileEntry
(long fileEntryId, String owner, long expirationTime, ServiceContext serviceContext) copyFileEntry
(long groupId, long repositoryId, long sourceFileEntryId, long targetFolderId, ServiceContext serviceContext) void
deleteFileEntry
(long fileEntryId) void
deleteFileEntry
(long groupId, long folderId, String title) void
deleteFileEntryByExternalReferenceCode
(String externalReferenceCode, long groupId) void
deleteFileVersion
(long fileEntryId, String version) fetchFileEntry
(long groupId, long folderId, String title) fetchFileEntryByExternalReferenceCode
(long groupId, String externalReferenceCode) fetchFileEntryByImageId
(long imageId) getFileAsStream
(long fileEntryId, String version) getFileAsStream
(long fileEntryId, String version, boolean incrementCounter) getFileEntries
(long groupId, double score, int start, int end) getFileEntries
(long groupId, long folderId, int status, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) getFileEntries
(long groupId, long folderId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) getFileEntries
(long groupId, long folderId, long fileEntryTypeId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) getFileEntries
(long groupId, long folderId, String[] mimeTypes, int status, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) getFileEntries
(long groupId, long folderId, String[] mimeTypes, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) int
getFileEntriesCount
(long groupId, double score) 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) int
getFileEntriesCount
(long groupId, long folderId, String[] mimeTypes, int status) getFileEntry
(long fileEntryId) getFileEntry
(long groupId, long folderId, String title) getFileEntryByExternalReferenceCode
(String externalReferenceCode, long groupId) getFileEntryByFileName
(long groupId, long folderId, String fileName) getFileEntryByUuidAndGroupId
(String uuid, long groupId) getFileEntryLock
(long fileEntryId) int
getFoldersFileEntriesCount
(long groupId, List<Long> folderIds, int status) getGroupFileEntries
(long groupId, long userId, long rootFolderId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) getGroupFileEntries
(long groupId, long userId, long repositoryId, long rootFolderId, String[] mimeTypes, int status, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) getGroupFileEntries
(long groupId, long userId, long rootFolderId, String[] mimeTypes, int status, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) 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) Returns the OSGi service identifier.boolean
hasFileEntryLock
(long fileEntryId) boolean
isFileEntryCheckedOut
(long fileEntryId) moveFileEntry
(long fileEntryId, long newFolderId, ServiceContext serviceContext) refreshFileEntryLock
(String lockUuid, long companyId, long expirationTime) void
revertFileEntry
(long fileEntryId, String version, ServiceContext serviceContext) search
(long groupId, long creatorUserId, int status, int start, int end) search
(long groupId, long creatorUserId, long folderId, String[] mimeTypes, int status, int start, int end) updateFileEntry
(long fileEntryId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, long fileEntryTypeId, Map<String, DDMFormValues> ddmFormValuesMap, File file, InputStream inputStream, long size, Date displayDate, Date expirationDate, Date reviewDate, ServiceContext serviceContext) 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)
-
Method Details
-
addFileEntry
DLFileEntry addFileEntry(String externalReferenceCode, long groupId, long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, long fileEntryTypeId, Map<String, DDMFormValues> ddmFormValuesMap, File file, InputStream inputStream, long size, Date displayDate, Date expirationDate, Date reviewDate, ServiceContext serviceContext) throws PortalException- Throws:
PortalException
-
cancelCheckOut
- Throws:
PortalException
-
checkInFileEntry
void checkInFileEntry(long fileEntryId, DLVersionNumberIncrease dlVersionNumberIncrease, String changeLog, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
checkInFileEntry
void checkInFileEntry(long fileEntryId, String lockUuid, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
checkOutFileEntry
DLFileEntry checkOutFileEntry(long fileEntryId, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
checkOutFileEntry
DLFileEntry checkOutFileEntry(long fileEntryId, String owner, long expirationTime, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
copyFileEntry
DLFileEntry copyFileEntry(long groupId, long repositoryId, long sourceFileEntryId, long targetFolderId, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
deleteFileEntry
- Throws:
PortalException
-
deleteFileEntry
- Throws:
PortalException
-
deleteFileEntryByExternalReferenceCode
void deleteFileEntryByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException - Throws:
PortalException
-
deleteFileVersion
- Throws:
PortalException
-
fetchFileEntry
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileEntry fetchFileEntry(long groupId, long folderId, String title) throws PortalException - Throws:
PortalException
-
fetchFileEntryByExternalReferenceCode
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileEntry fetchFileEntryByExternalReferenceCode(long groupId, String externalReferenceCode) throws PortalException - Throws:
PortalException
-
fetchFileEntryByImageId
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileEntry fetchFileEntryByImageId(long imageId) throws PortalException - Throws:
PortalException
-
getFileAsStream
@Transactional(propagation=SUPPORTS, readOnly=true) InputStream getFileAsStream(long fileEntryId, String version) throws PortalException - Throws:
PortalException
-
getFileAsStream
@Transactional(propagation=SUPPORTS, readOnly=true) InputStream getFileAsStream(long fileEntryId, String version, boolean incrementCounter) throws PortalException - Throws:
PortalException
-
getFileEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileEntry> getFileEntries(long groupId, double score, int start, int end) throws PortalException - Throws:
PortalException
-
getFileEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileEntry> getFileEntries(long groupId, long folderId, int status, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) throws PortalException - Throws:
PortalException
-
getFileEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileEntry> getFileEntries(long groupId, long folderId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) throws PortalException - Throws:
PortalException
-
getFileEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileEntry> getFileEntries(long groupId, long folderId, long fileEntryTypeId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) throws PortalException - Throws:
PortalException
-
getFileEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileEntry> getFileEntries(long groupId, long folderId, String[] mimeTypes, int status, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) throws PortalException - Throws:
PortalException
-
getFileEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileEntry> getFileEntries(long groupId, long folderId, String[] mimeTypes, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) throws PortalException - Throws:
PortalException
-
getFileEntriesCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getFileEntriesCount(long groupId, double score) throws PortalException - Throws:
PortalException
-
getFileEntriesCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getFileEntriesCount(long groupId, long folderId) -
getFileEntriesCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getFileEntriesCount(long groupId, long folderId, int status) -
getFileEntriesCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getFileEntriesCount(long groupId, long folderId, long fileEntryTypeId) -
getFileEntriesCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getFileEntriesCount(long groupId, long folderId, String[] mimeTypes) -
getFileEntriesCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getFileEntriesCount(long groupId, long folderId, String[] mimeTypes, int status) -
getFileEntry
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileEntry getFileEntry(long fileEntryId) throws PortalException - Throws:
PortalException
-
getFileEntry
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileEntry getFileEntry(long groupId, long folderId, String title) throws PortalException - Throws:
PortalException
-
getFileEntryByExternalReferenceCode
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileEntry getFileEntryByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException - Throws:
PortalException
-
getFileEntryByFileName
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileEntry getFileEntryByFileName(long groupId, long folderId, String fileName) throws PortalException - Throws:
PortalException
-
getFileEntryByUuidAndGroupId
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileEntry getFileEntryByUuidAndGroupId(String uuid, long groupId) throws PortalException - Throws:
PortalException
-
getFileEntryLock
-
getFoldersFileEntriesCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getFoldersFileEntriesCount(long groupId, List<Long> folderIds, int status) -
getGroupFileEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileEntry> getGroupFileEntries(long groupId, long userId, long rootFolderId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) throws PortalException - Throws:
PortalException
-
getGroupFileEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileEntry> getGroupFileEntries(long groupId, long userId, long repositoryId, long rootFolderId, String[] mimeTypes, int status, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) throws PortalException - Throws:
PortalException
-
getGroupFileEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileEntry> getGroupFileEntries(long groupId, long userId, long rootFolderId, String[] mimeTypes, int status, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) throws PortalException - Throws:
PortalException
-
getGroupFileEntriesCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getGroupFileEntriesCount(long groupId, long userId, long rootFolderId) throws PortalException - Throws:
PortalException
-
getGroupFileEntriesCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getGroupFileEntriesCount(long groupId, long userId, long repositoryId, long rootFolderId, String[] mimeTypes, int status) throws PortalException - Throws:
PortalException
-
getGroupFileEntriesCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getGroupFileEntriesCount(long groupId, long userId, long rootFolderId, String[] mimeTypes, int status) throws PortalException - Throws:
PortalException
-
getOSGiServiceIdentifier
String getOSGiServiceIdentifier()Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
hasFileEntryLock
@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasFileEntryLock(long fileEntryId) throws PortalException - Throws:
PortalException
-
isFileEntryCheckedOut
@Transactional(propagation=SUPPORTS, readOnly=true) boolean isFileEntryCheckedOut(long fileEntryId) throws PortalException - Throws:
PortalException
-
moveFileEntry
DLFileEntry moveFileEntry(long fileEntryId, long newFolderId, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
refreshFileEntryLock
Lock refreshFileEntryLock(String lockUuid, long companyId, long expirationTime) throws PortalException - Throws:
PortalException
-
revertFileEntry
void revertFileEntry(long fileEntryId, String version, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
search
@Transactional(propagation=SUPPORTS, readOnly=true) Hits search(long groupId, long creatorUserId, int status, int start, int end) throws PortalException - Throws:
PortalException
-
search
@Transactional(propagation=SUPPORTS, readOnly=true) Hits search(long groupId, long creatorUserId, long folderId, String[] mimeTypes, int status, int start, int end) throws PortalException - Throws:
PortalException
-
updateFileEntry
DLFileEntry updateFileEntry(long fileEntryId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, long fileEntryTypeId, Map<String, DDMFormValues> ddmFormValuesMap, File file, InputStream inputStream, long size, Date displayDate, Date expirationDate, Date reviewDate, ServiceContext serviceContext) throws PortalException- Throws:
PortalException
-
updateStatus
DLFileEntry updateStatus(long userId, long fileVersionId, int status, ServiceContext serviceContext, Map<String, Serializable> workflowContext) throws PortalException- Throws:
PortalException
-
verifyFileEntryCheckOut
- Throws:
PortalException
-
verifyFileEntryLock
- Throws:
PortalException
-