Interface Repository
- All Superinterfaces:
CapabilityProvider
,DocumentRepository
- All Known Subinterfaces:
BaseRepository
- All Known Implementing Classes:
BaseRepositoryImpl
,BaseRepositoryProxyBean
- Author:
- Alexander Chow
-
Method Summary
Modifier and TypeMethodDescriptioncancelCheckOut
(long fileEntryId) Cancels the file entry check out.checkOutFileEntry
(long fileEntryId, ServiceContext serviceContext) checkOutFileEntry
(long fileEntryId, String owner, long expirationTime, ServiceContext serviceContext) void
deleteFileEntry
(long folderId, String title) void
deleteFileVersion
(long fileEntryId, String version) void
deleteFolder
(long parentFolderId, String name) getFileEntries
(long folderId, long fileEntryTypeId, int start, int end, OrderByComparator<FileEntry> orderByComparator) getFileEntries
(long folderId, String[] mimeTypes, int start, int end, OrderByComparator<FileEntry> orderByComparator) int
getFileEntriesAndFileShortcutsCount
(long folderId, int status, String[] mimeTypes) int
getFileEntriesCount
(long folderId, long fileEntryTypeId) int
getFileEntriesCount
(long folderId, String[] mimeTypes) default List<RepositoryEntry>
getFoldersAndFileEntriesAndFileShortcuts
(long folderId, int status, String[] mimeTypes, boolean includeMountFolders, boolean includeOwner, int start, int end, OrderByComparator<?> orderByComparator) getFoldersAndFileEntriesAndFileShortcuts
(long folderId, int status, String[] mimeTypes, boolean includeMountFolders, int start, int end, OrderByComparator<?> orderByComparator) int
getFoldersAndFileEntriesAndFileShortcutsCount
(long folderId, int status, String[] mimeTypes, boolean includeMountFolders) default int
getFoldersAndFileEntriesAndFileShortcutsCount
(long folderId, int status, String[] mimeTypes, boolean includeMountFolders, boolean includeOwner) int
getFoldersFileEntriesCount
(List<Long> folderIds, int status) getMountFolders
(long parentFolderId, int start, int end, OrderByComparator<Folder> orderByComparator) int
getMountFoldersCount
(long parentFolderId) getRepositoryFileEntries
(long userId, long rootFolderId, String[] mimeTypes, int status, int start, int end, OrderByComparator<FileEntry> orderByComparator) int
getRepositoryFileEntriesCount
(long userId, long rootFolderId) int
getRepositoryFileEntriesCount
(long userId, long rootFolderId, String[] mimeTypes, int status) getRepositoryFileShortcuts
(long groupId) getSubfolderIds
(long folderId, boolean recurse) void
getSubfolderIds
(List<Long> folderIds, long folderId) lockFolder
(long folderId) lockFolder
(long folderId, String owner, boolean inheritable, long expirationTime) refreshFileEntryLock
(String lockUuid, long companyId, long expirationTime) refreshFolderLock
(String lockUuid, long companyId, long expirationTime) search
(long creatorUserId, int status, int start, int end) search
(SearchContext searchContext) search
(SearchContext searchContext, Query query) void
unlockFolder
(long folderId, String lockUuid) void
unlockFolder
(long parentFolderId, String name, String lockUuid) updateFolder
(long folderId, String name, String description, ServiceContext serviceContext) boolean
verifyFileEntryCheckOut
(long fileEntryId, String lockUuid) boolean
verifyFileEntryLock
(long fileEntryId, String lockUuid) boolean
verifyInheritableLock
(long folderId, String lockUuid) Methods inherited from interface com.liferay.portal.kernel.repository.capabilities.CapabilityProvider
getCapability, isCapabilityProvided
Methods inherited from interface com.liferay.portal.kernel.repository.DocumentRepository
addFileEntry, addFileEntry, addFileShortcut, addFolder, checkInFileEntry, checkInFileEntry, copyFileEntry, deleteAll, deleteFileEntry, deleteFileShortcut, deleteFileShortcuts, deleteFileVersion, deleteFolder, fetchFileEntry, fetchFileEntryByExternalReferenceCode, fetchFileShortcut, fetchFileShortcutByExternalReferenceCode, fetchFolderByExternalReferenceCode, getFileEntries, getFileEntries, getFileEntries, getFileEntriesAndFileShortcuts, getFileEntriesAndFileShortcutsCount, getFileEntriesCount, getFileEntriesCount, getFileEntriesCount, getFileEntry, getFileEntry, getFileEntryByExternalReferenceCode, getFileEntryByFileName, getFileEntryByUuid, getFileShortcut, getFileShortcutByExternalReferenceCode, getFileVersion, getFolder, getFolder, getFolderByExternalReferenceCode, getFolders, getFolders, getFoldersAndFileEntriesAndFileShortcuts, getFoldersAndFileEntriesAndFileShortcutsCount, getFoldersCount, getFoldersCount, getRepositoryFileEntries, getRepositoryId, moveFileEntry, moveFolder, revertFileEntry, updateFileEntry, updateFileEntry, updateFileShortcut, updateFileShortcuts, updateFolder
-
Method Details
-
cancelCheckOut
Cancels the file entry check out. If the file entry is not checked out, invoking this method results in no changes.- Parameters:
fileEntryId
- the primary key of the file entry to cancel the check out- Returns:
- the file entry if the cancel checkout operation was successful;
null
if the file entry was not checked out - Throws:
PortalException
- See Also:
-
checkOutFileEntry
- Throws:
PortalException
-
checkOutFileEntry
FileEntry checkOutFileEntry(long fileEntryId, String owner, long expirationTime, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
deleteFileEntry
- Throws:
PortalException
-
deleteFileVersion
- Throws:
PortalException
-
deleteFolder
- Throws:
PortalException
-
getFileEntries
List<FileEntry> getFileEntries(long folderId, long fileEntryTypeId, int start, int end, OrderByComparator<FileEntry> orderByComparator) throws PortalException - Throws:
PortalException
-
getFileEntries
List<FileEntry> getFileEntries(long folderId, String[] mimeTypes, int start, int end, OrderByComparator<FileEntry> orderByComparator) throws PortalException - Throws:
PortalException
-
getFileEntriesAndFileShortcutsCount
int getFileEntriesAndFileShortcutsCount(long folderId, int status, String[] mimeTypes) throws PortalException - Throws:
PortalException
-
getFileEntriesCount
- Throws:
PortalException
-
getFileEntriesCount
- Throws:
PortalException
-
getFoldersAndFileEntriesAndFileShortcuts
default List<RepositoryEntry> getFoldersAndFileEntriesAndFileShortcuts(long folderId, int status, String[] mimeTypes, boolean includeMountFolders, boolean includeOwner, int start, int end, OrderByComparator<?> orderByComparator) throws PortalException - Throws:
PortalException
-
getFoldersAndFileEntriesAndFileShortcuts
List<RepositoryEntry> getFoldersAndFileEntriesAndFileShortcuts(long folderId, int status, String[] mimeTypes, boolean includeMountFolders, int start, int end, OrderByComparator<?> orderByComparator) throws PortalException - Throws:
PortalException
-
getFoldersAndFileEntriesAndFileShortcutsCount
int getFoldersAndFileEntriesAndFileShortcutsCount(long folderId, int status, String[] mimeTypes, boolean includeMountFolders) throws PortalException - Throws:
PortalException
-
getFoldersAndFileEntriesAndFileShortcutsCount
default int getFoldersAndFileEntriesAndFileShortcutsCount(long folderId, int status, String[] mimeTypes, boolean includeMountFolders, boolean includeOwner) throws PortalException - Throws:
PortalException
-
getFoldersFileEntriesCount
- Throws:
PortalException
-
getMountFolders
List<Folder> getMountFolders(long parentFolderId, int start, int end, OrderByComparator<Folder> orderByComparator) throws PortalException - Throws:
PortalException
-
getMountFoldersCount
- Throws:
PortalException
-
getRepositoryFileEntries
List<FileEntry> getRepositoryFileEntries(long userId, long rootFolderId, String[] mimeTypes, int status, int start, int end, OrderByComparator<FileEntry> orderByComparator) throws PortalException - Throws:
PortalException
-
getRepositoryFileEntriesCount
- Throws:
PortalException
-
getRepositoryFileEntriesCount
int getRepositoryFileEntriesCount(long userId, long rootFolderId, String[] mimeTypes, int status) throws PortalException - Throws:
PortalException
-
getRepositoryFileShortcuts
- Throws:
PortalException
-
getSubfolderIds
- Throws:
PortalException
-
getSubfolderIds
- Throws:
PortalException
-
lockFolder
- Throws:
PortalException
-
lockFolder
Lock lockFolder(long folderId, String owner, boolean inheritable, long expirationTime) throws PortalException - Throws:
PortalException
-
refreshFileEntryLock
Lock refreshFileEntryLock(String lockUuid, long companyId, long expirationTime) throws PortalException - Throws:
PortalException
-
refreshFolderLock
- Throws:
PortalException
-
search
- Throws:
PortalException
-
search
Hits search(long creatorUserId, long folderId, String[] mimeTypes, int status, int start, int end) throws PortalException - Throws:
PortalException
-
search
- Throws:
SearchException
-
search
- Throws:
SearchException
-
unlockFolder
- Throws:
PortalException
-
unlockFolder
- Throws:
PortalException
-
updateFolder
Folder updateFolder(long folderId, String name, String description, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
verifyFileEntryCheckOut
- Throws:
PortalException
-
verifyFileEntryLock
- Throws:
PortalException
-
verifyInheritableLock
- Throws:
PortalException
-