com.liferay.portal.kernel.repository

Interface Repository

All Superinterfaces:

CapabilityProvider, DocumentRepository

All Known Subinterfaces:

BaseRepository

All Known Implementing Classes:

BaseRepositoryImpl, BaseRepositoryProxyBean

public interface Repository
extends DocumentRepository

Author:

Alexander Chow

Method Summary

Modifier and Type	Method and Description
FileEntry	addFileEntry(long folderId, java.lang.String sourceFileName, java.lang.String mimeType, java.lang.String title, java.lang.String description, java.lang.String changeLog, java.io.File file, ServiceContext serviceContext) Deprecated. As of 7.0.0, see DocumentRepository.addFileEntry(long, long, String, String, String, String, String, File, ServiceContext)
FileEntry	addFileEntry(long folderId, java.lang.String sourceFileName, java.lang.String mimeType, java.lang.String title, java.lang.String description, java.lang.String changeLog, java.io.InputStream is, long size, ServiceContext serviceContext) Deprecated. As of 7.0.0, see DocumentRepository.addFileEntry(long, long, String, String, String, String, String, InputStream, long, ServiceContext)
Folder	addFolder(long parentFolderId, java.lang.String name, java.lang.String description, ServiceContext serviceContext) Deprecated. As of 7.0.0, replaced by DocumentRepository.addFolder(long, long, String, String, ServiceContext)
FileVersion	cancelCheckOut(long fileEntryId) Cancels the file entry check out.
void	checkInFileEntry(long fileEntryId, boolean major, java.lang.String changeLog, ServiceContext serviceContext) Deprecated. As of 7.0.0, replaced by DocumentRepository.checkInFileEntry(long, long, boolean, String, ServiceContext)
void	checkInFileEntry(long fileEntryId, java.lang.String lockUuid, ServiceContext serviceContext) Deprecated. As of 7.0.0, replaced by DocumentRepository.checkInFileEntry(long, long, String, ServiceContext)
FileEntry	checkOutFileEntry(long fileEntryId, ServiceContext serviceContext)
FileEntry	checkOutFileEntry(long fileEntryId, java.lang.String owner, long expirationTime, ServiceContext serviceContext)
FileEntry	copyFileEntry(long groupId, long fileEntryId, long destFolderId, ServiceContext serviceContext) Deprecated. As of 7.0.0, replaced by DocumentRepository.copyFileEntry(long, long, long, long, ServiceContext)
void	deleteFileEntry(long folderId, java.lang.String title)
void	deleteFileVersion(long fileEntryId, java.lang.String version)
void	deleteFolder(long parentFolderId, java.lang.String name)
java.util.List<FileEntry>	getFileEntries(long folderId, long fileEntryTypeId, int start, int end, OrderByComparator<FileEntry> obc)
java.util.List<FileEntry>	getFileEntries(long folderId, java.lang.String[] mimeTypes, int start, int end, OrderByComparator<FileEntry> obc)
int	getFileEntriesAndFileShortcutsCount(long folderId, int status, java.lang.String[] mimeTypes)
int	getFileEntriesCount(long folderId, long fileEntryTypeId)
int	getFileEntriesCount(long folderId, java.lang.String[] mimeTypes)
default java.util.List<RepositoryEntry>	getFoldersAndFileEntriesAndFileShortcuts(long folderId, int status, java.lang.String[] mimeTypes, boolean includeMountFolders, boolean includeOwner, int start, int end, OrderByComparator<?> obc)
java.util.List<RepositoryEntry>	getFoldersAndFileEntriesAndFileShortcuts(long folderId, int status, java.lang.String[] mimeTypes, boolean includeMountFolders, int start, int end, OrderByComparator<?> obc)
int	getFoldersAndFileEntriesAndFileShortcutsCount(long folderId, int status, java.lang.String[] mimeTypes, boolean includeMountFolders)
default int	getFoldersAndFileEntriesAndFileShortcutsCount(long folderId, int status, java.lang.String[] mimeTypes, boolean includeMountFolders, boolean includeOwner)
int	getFoldersFileEntriesCount(java.util.List<java.lang.Long> folderIds, int status)
java.util.List<Folder>	getMountFolders(long parentFolderId, int start, int end, OrderByComparator<Folder> obc)
int	getMountFoldersCount(long parentFolderId)
java.util.List<FileEntry>	getRepositoryFileEntries(long userId, long rootFolderId, java.lang.String[] mimeTypes, int status, int start, int end, OrderByComparator<FileEntry> obc)
int	getRepositoryFileEntriesCount(long userId, long rootFolderId)
int	getRepositoryFileEntriesCount(long userId, long rootFolderId, java.lang.String[] mimeTypes, int status)
void	getSubfolderIds(java.util.List<java.lang.Long> folderIds, long folderId)
java.util.List<java.lang.Long>	getSubfolderIds(long folderId, boolean recurse)
Lock	lockFolder(long folderId)
Lock	lockFolder(long folderId, java.lang.String owner, boolean inheritable, long expirationTime)
FileEntry	moveFileEntry(long fileEntryId, long newFolderId, ServiceContext serviceContext) Deprecated. As of 7.0.0, replaced by DocumentRepository.moveFileEntry(long, long, long, ServiceContext)
Folder	moveFolder(long folderId, long newParentFolderId, ServiceContext serviceContext) Deprecated. As of 7.0.0, replaced by DocumentRepository.moveFolder(long, long, long, ServiceContext)
Lock	refreshFileEntryLock(java.lang.String lockUuid, long companyId, long expirationTime)
Lock	refreshFolderLock(java.lang.String lockUuid, long companyId, long expirationTime)
void	revertFileEntry(long fileEntryId, java.lang.String version, ServiceContext serviceContext) Deprecated. As of 7.0.0, replaced by DocumentRepository.revertFileEntry(long, long, String, ServiceContext)
Hits	search(long creatorUserId, int status, int start, int end)
Hits	search(long creatorUserId, long folderId, java.lang.String[] mimeTypes, int status, int start, int end)
Hits	search(SearchContext searchContext)
Hits	search(SearchContext searchContext, Query query)
void	unlockFolder(long folderId, java.lang.String lockUuid)
void	unlockFolder(long parentFolderId, java.lang.String name, java.lang.String lockUuid)
FileEntry	updateFileEntry(long fileEntryId, java.lang.String sourceFileName, java.lang.String mimeType, java.lang.String title, java.lang.String description, java.lang.String changeLog, boolean majorVersion, java.io.File file, ServiceContext serviceContext) Deprecated. As of 7.0.0, replaced by DocumentRepository.updateFileEntry(long, long, String, String, String, String, String, boolean, File, ServiceContext)
FileEntry	updateFileEntry(long fileEntryId, java.lang.String sourceFileName, java.lang.String mimeType, java.lang.String title, java.lang.String description, java.lang.String changeLog, boolean majorVersion, java.io.InputStream is, long size, ServiceContext serviceContext) Deprecated. As of 7.0.0, replaced by DocumentRepository.updateFileEntry(long, long, String, String, String, String, String, boolean, InputStream, long, ServiceContext)
Folder	updateFolder(long folderId, java.lang.String name, java.lang.String description, ServiceContext serviceContext)
boolean	verifyFileEntryCheckOut(long fileEntryId, java.lang.String lockUuid)
boolean	verifyFileEntryLock(long fileEntryId, java.lang.String lockUuid)
boolean	verifyInheritableLock(long folderId, java.lang.String lockUuid)

Methods inherited from interface com.liferay.portal.kernel.repository.DocumentRepository

addFileEntry, addFileEntry, addFileShortcut, addFolder, checkInFileEntry, checkInFileEntry, copyFileEntry, deleteAll, deleteFileEntry, deleteFileShortcut, deleteFileShortcuts, deleteFolder, getFileEntries, getFileEntries, getFileEntries, getFileEntriesAndFileShortcuts, getFileEntriesAndFileShortcutsCount, getFileEntriesCount, getFileEntriesCount, getFileEntriesCount, getFileEntry, getFileEntry, getFileEntryByUuid, getFileShortcut, getFileVersion, getFolder, getFolder, getFolders, getFolders, getFoldersAndFileEntriesAndFileShortcuts, getFoldersAndFileEntriesAndFileShortcutsCount, getFoldersCount, getFoldersCount, getRepositoryFileEntries, getRepositoryId, moveFileEntry, moveFolder, revertFileEntry, updateFileEntry, updateFileEntry, updateFileShortcut, updateFileShortcuts, updateFolder

Methods inherited from interface com.liferay.portal.kernel.repository.capabilities.CapabilityProvider

getCapability, isCapabilityProvided

Method Detail

addFileEntry

@Deprecated
FileEntry addFileEntry(long folderId,
                                   java.lang.String sourceFileName,
                                   java.lang.String mimeType,
                                   java.lang.String title,
                                   java.lang.String description,
                                   java.lang.String changeLog,
                                   java.io.File file,
                                   ServiceContext serviceContext)
                            throws PortalException

Deprecated. As of 7.0.0, see DocumentRepository.addFileEntry(long, long, String, String, String, String, String, File, ServiceContext)

Throws:

PortalException

addFileEntry

@Deprecated
FileEntry addFileEntry(long folderId,
                                   java.lang.String sourceFileName,
                                   java.lang.String mimeType,
                                   java.lang.String title,
                                   java.lang.String description,
                                   java.lang.String changeLog,
                                   java.io.InputStream is,
                                   long size,
                                   ServiceContext serviceContext)
                            throws PortalException

Deprecated. As of 7.0.0, see DocumentRepository.addFileEntry(long, long, String, String, String, String, String, InputStream, long, ServiceContext)

Throws:

PortalException

addFolder

@Deprecated
Folder addFolder(long parentFolderId,
                             java.lang.String name,
                             java.lang.String description,
                             ServiceContext serviceContext)
                      throws PortalException

Deprecated. As of 7.0.0, replaced by DocumentRepository.addFolder(long, long, String, String, ServiceContext)

Throws:

PortalException

cancelCheckOut

FileVersion cancelCheckOut(long fileEntryId)
                    throws PortalException

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:

DocumentRepository.checkInFileEntry(long, long, boolean, String, ServiceContext), checkOutFileEntry(long, ServiceContext)

checkInFileEntry

@Deprecated
void checkInFileEntry(long fileEntryId,
                                  boolean major,
                                  java.lang.String changeLog,
                                  ServiceContext serviceContext)
                           throws PortalException

Deprecated. As of 7.0.0, replaced by DocumentRepository.checkInFileEntry(long, long, boolean, String, ServiceContext)

Throws:

PortalException

checkInFileEntry

@Deprecated
void checkInFileEntry(long fileEntryId,
                                  java.lang.String lockUuid,
                                  ServiceContext serviceContext)
                           throws PortalException

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

Throws:

PortalException

checkOutFileEntry

FileEntry checkOutFileEntry(long fileEntryId,
                            ServiceContext serviceContext)
                     throws PortalException

Throws:

PortalException

checkOutFileEntry

FileEntry checkOutFileEntry(long fileEntryId,
                            java.lang.String owner,
                            long expirationTime,
                            ServiceContext serviceContext)
                     throws PortalException

Throws:

PortalException

copyFileEntry

@Deprecated
FileEntry copyFileEntry(long groupId,
                                    long fileEntryId,
                                    long destFolderId,
                                    ServiceContext serviceContext)
                             throws PortalException

Deprecated. As of 7.0.0, replaced by DocumentRepository.copyFileEntry(long, long, long, long, ServiceContext)

Throws:

PortalException

deleteFileEntry

void deleteFileEntry(long folderId,
                     java.lang.String title)
              throws PortalException

Throws:

PortalException

deleteFileVersion

void deleteFileVersion(long fileEntryId,
                       java.lang.String version)
                throws PortalException

Throws:

PortalException

deleteFolder

void deleteFolder(long parentFolderId,
                  java.lang.String name)
           throws PortalException

Throws:

PortalException

getFileEntries

java.util.List<FileEntry> getFileEntries(long folderId,
                                         long fileEntryTypeId,
                                         int start,
                                         int end,
                                         OrderByComparator<FileEntry> obc)
                                  throws PortalException

Throws:

PortalException

getFileEntries

java.util.List<FileEntry> getFileEntries(long folderId,
                                         java.lang.String[] mimeTypes,
                                         int start,
                                         int end,
                                         OrderByComparator<FileEntry> obc)
                                  throws PortalException

Throws:

PortalException

getFileEntriesAndFileShortcutsCount

int getFileEntriesAndFileShortcutsCount(long folderId,
                                        int status,
                                        java.lang.String[] mimeTypes)
                                 throws PortalException

Throws:

PortalException

getFileEntriesCount

int getFileEntriesCount(long folderId,
                        long fileEntryTypeId)
                 throws PortalException

Throws:

PortalException

getFileEntriesCount

int getFileEntriesCount(long folderId,
                        java.lang.String[] mimeTypes)
                 throws PortalException

Throws:

PortalException

getFoldersAndFileEntriesAndFileShortcuts

default java.util.List<RepositoryEntry> getFoldersAndFileEntriesAndFileShortcuts(long folderId,
                                                                                 int status,
                                                                                 java.lang.String[] mimeTypes,
                                                                                 boolean includeMountFolders,
                                                                                 boolean includeOwner,
                                                                                 int start,
                                                                                 int end,
                                                                                 OrderByComparator<?> obc)
                                                                          throws PortalException

Throws:

PortalException

getFoldersAndFileEntriesAndFileShortcuts

java.util.List<RepositoryEntry> getFoldersAndFileEntriesAndFileShortcuts(long folderId,
                                                                         int status,
                                                                         java.lang.String[] mimeTypes,
                                                                         boolean includeMountFolders,
                                                                         int start,
                                                                         int end,
                                                                         OrderByComparator<?> obc)
                                                                  throws PortalException

Throws:

PortalException

getFoldersAndFileEntriesAndFileShortcutsCount

int getFoldersAndFileEntriesAndFileShortcutsCount(long folderId,
                                                  int status,
                                                  java.lang.String[] mimeTypes,
                                                  boolean includeMountFolders)
                                           throws PortalException

Throws:

PortalException

getFoldersAndFileEntriesAndFileShortcutsCount

default int getFoldersAndFileEntriesAndFileShortcutsCount(long folderId,
                                                          int status,
                                                          java.lang.String[] mimeTypes,
                                                          boolean includeMountFolders,
                                                          boolean includeOwner)
                                                   throws PortalException

Throws:

PortalException

getFoldersFileEntriesCount

int getFoldersFileEntriesCount(java.util.List<java.lang.Long> folderIds,
                               int status)
                        throws PortalException

Throws:

PortalException

getMountFolders

java.util.List<Folder> getMountFolders(long parentFolderId,
                                       int start,
                                       int end,
                                       OrderByComparator<Folder> obc)
                                throws PortalException

Throws:

PortalException

getMountFoldersCount

int getMountFoldersCount(long parentFolderId)
                  throws PortalException

Throws:

PortalException

getRepositoryFileEntries

java.util.List<FileEntry> getRepositoryFileEntries(long userId,
                                                   long rootFolderId,
                                                   java.lang.String[] mimeTypes,
                                                   int status,
                                                   int start,
                                                   int end,
                                                   OrderByComparator<FileEntry> obc)
                                            throws PortalException

Throws:

PortalException

getRepositoryFileEntriesCount

int getRepositoryFileEntriesCount(long userId,
                                  long rootFolderId)
                           throws PortalException

Throws:

PortalException

getRepositoryFileEntriesCount

int getRepositoryFileEntriesCount(long userId,
                                  long rootFolderId,
                                  java.lang.String[] mimeTypes,
                                  int status)
                           throws PortalException

Throws:

PortalException

getSubfolderIds

void getSubfolderIds(java.util.List<java.lang.Long> folderIds,
                     long folderId)
              throws PortalException

Throws:

PortalException

getSubfolderIds

java.util.List<java.lang.Long> getSubfolderIds(long folderId,
                                               boolean recurse)
                                        throws PortalException

Throws:

PortalException

lockFolder

Lock lockFolder(long folderId)
         throws PortalException

Throws:

PortalException

lockFolder

Lock lockFolder(long folderId,
                java.lang.String owner,
                boolean inheritable,
                long expirationTime)
         throws PortalException

Throws:

PortalException

moveFileEntry

@Deprecated
FileEntry moveFileEntry(long fileEntryId,
                                    long newFolderId,
                                    ServiceContext serviceContext)
                             throws PortalException

Deprecated. As of 7.0.0, replaced by DocumentRepository.moveFileEntry(long, long, long, ServiceContext)

Throws:

PortalException

moveFolder

@Deprecated
Folder moveFolder(long folderId,
                              long newParentFolderId,
                              ServiceContext serviceContext)
                       throws PortalException

Deprecated. As of 7.0.0, replaced by DocumentRepository.moveFolder(long, long, long, ServiceContext)

Throws:

PortalException

refreshFileEntryLock

Lock refreshFileEntryLock(java.lang.String lockUuid,
                          long companyId,
                          long expirationTime)
                   throws PortalException

Throws:

PortalException

refreshFolderLock

Lock refreshFolderLock(java.lang.String lockUuid,
                       long companyId,
                       long expirationTime)
                throws PortalException

Throws:

PortalException

revertFileEntry

@Deprecated
void revertFileEntry(long fileEntryId,
                                 java.lang.String version,
                                 ServiceContext serviceContext)
                          throws PortalException

Deprecated. As of 7.0.0, replaced by DocumentRepository.revertFileEntry(long, long, String, ServiceContext)

Throws:

PortalException

search

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

Throws:

PortalException

search

Hits search(long creatorUserId,
            long folderId,
            java.lang.String[] mimeTypes,
            int status,
            int start,
            int end)
     throws PortalException

Throws:

PortalException

search

Hits search(SearchContext searchContext)
     throws SearchException

Throws:

SearchException

search

Hits search(SearchContext searchContext,
            Query query)
     throws SearchException

Throws:

SearchException

unlockFolder

void unlockFolder(long folderId,
                  java.lang.String lockUuid)
           throws PortalException

Throws:

PortalException

unlockFolder

void unlockFolder(long parentFolderId,
                  java.lang.String name,
                  java.lang.String lockUuid)
           throws PortalException

Throws:

PortalException

updateFileEntry

@Deprecated
FileEntry updateFileEntry(long fileEntryId,
                                      java.lang.String sourceFileName,
                                      java.lang.String mimeType,
                                      java.lang.String title,
                                      java.lang.String description,
                                      java.lang.String changeLog,
                                      boolean majorVersion,
                                      java.io.File file,
                                      ServiceContext serviceContext)
                               throws PortalException

Deprecated. As of 7.0.0, replaced by DocumentRepository.updateFileEntry(long, long, String, String, String, String, String, boolean, File, ServiceContext)

Throws:

PortalException

updateFileEntry

@Deprecated
FileEntry updateFileEntry(long fileEntryId,
                                      java.lang.String sourceFileName,
                                      java.lang.String mimeType,
                                      java.lang.String title,
                                      java.lang.String description,
                                      java.lang.String changeLog,
                                      boolean majorVersion,
                                      java.io.InputStream is,
                                      long size,
                                      ServiceContext serviceContext)
                               throws PortalException

Deprecated. As of 7.0.0, replaced by DocumentRepository.updateFileEntry(long, long, String, String, String, String, String, boolean, InputStream, long, ServiceContext)

Throws:

PortalException

updateFolder

Folder updateFolder(long folderId,
                    java.lang.String name,
                    java.lang.String description,
                    ServiceContext serviceContext)
             throws PortalException

Throws:

PortalException

verifyFileEntryCheckOut

boolean verifyFileEntryCheckOut(long fileEntryId,
                                java.lang.String lockUuid)
                         throws PortalException

Throws:

PortalException

verifyFileEntryLock

boolean verifyFileEntryLock(long fileEntryId,
                            java.lang.String lockUuid)
                     throws PortalException

Throws:

PortalException

verifyInheritableLock

boolean verifyInheritableLock(long folderId,
                              java.lang.String lockUuid)
                       throws PortalException

Throws:

PortalException