com.liferay.portal.kernel.repository

Interface DocumentRepository

All Superinterfaces:

CapabilityProvider

All Known Subinterfaces:

BaseRepository, LocalRepository, Repository

All Known Implementing Classes:

BaseCmisRepository, BaseRepositoryImpl, BaseRepositoryProxyBean, CMISRepositoryHandler, DefaultLocalRepositoryImpl, ExtRepositoryAdapter, LocalRepositoryProxyBean

public interface DocumentRepository
extends CapabilityProvider

Method Summary

Modifier and Type	Method and Description
FileEntry	addFileEntry(long userId, 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)
FileEntry	addFileEntry(long userId, 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)
FileShortcut	addFileShortcut(long userId, long folderId, long toFileEntryId, ServiceContext serviceContext)
Folder	addFolder(long userId, long parentFolderId, java.lang.String name, java.lang.String description, ServiceContext serviceContext)
void	checkInFileEntry(long userId, long fileEntryId, boolean majorVersion, java.lang.String changeLog, ServiceContext serviceContext)
void	checkInFileEntry(long userId, long fileEntryId, java.lang.String lockUuid, ServiceContext serviceContext)
FileEntry	copyFileEntry(long userId, long groupId, long fileEntryId, long destFolderId, ServiceContext serviceContext)
void	deleteAll()
void	deleteFileEntry(long fileEntryId)
void	deleteFileShortcut(long fileShortcutId)
void	deleteFileShortcuts(long toFileEntryId)
void	deleteFolder(long folderId)
java.util.List<FileEntry>	getFileEntries(long folderId, int status, int start, int end, OrderByComparator<FileEntry> obc)
java.util.List<FileEntry>	getFileEntries(long folderId, int start, int end, OrderByComparator<FileEntry> obc)
java.util.List<RepositoryEntry>	getFileEntriesAndFileShortcuts(long folderId, int status, int start, int end)
int	getFileEntriesAndFileShortcutsCount(long folderId, int status)
int	getFileEntriesCount(long folderId)
int	getFileEntriesCount(long folderId, int status)
FileEntry	getFileEntry(long fileEntryId)
FileEntry	getFileEntry(long folderId, java.lang.String title)
FileEntry	getFileEntryByUuid(java.lang.String uuid)
FileShortcut	getFileShortcut(long fileShortcutId)
FileVersion	getFileVersion(long fileVersionId)
Folder	getFolder(long folderId)
Folder	getFolder(long parentFolderId, java.lang.String name)
java.util.List<Folder>	getFolders(long parentFolderId, boolean includeMountFolders, int start, int end, OrderByComparator<Folder> obc)
java.util.List<Folder>	getFolders(long parentFolderId, int status, boolean includeMountFolders, int start, int end, OrderByComparator<Folder> obc)
java.util.List<RepositoryEntry>	getFoldersAndFileEntriesAndFileShortcuts(long folderId, int status, boolean includeMountFolders, int start, int end, OrderByComparator<?> obc)
int	getFoldersAndFileEntriesAndFileShortcutsCount(long folderId, int status, boolean includeMountFolders)
int	getFoldersCount(long parentFolderId, boolean includeMountfolders)
int	getFoldersCount(long parentFolderId, int status, boolean includeMountfolders)
java.util.List<FileEntry>	getRepositoryFileEntries(long userId, long rootFolderId, int start, int end, OrderByComparator<FileEntry> obc)
long	getRepositoryId()
FileEntry	moveFileEntry(long userId, long fileEntryId, long newFolderId, ServiceContext serviceContext)
Folder	moveFolder(long userId, long folderId, long parentFolderId, ServiceContext serviceContext)
void	revertFileEntry(long userId, long fileEntryId, java.lang.String version, ServiceContext serviceContext)
FileEntry	updateFileEntry(long userId, 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)
FileEntry	updateFileEntry(long userId, 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)
FileShortcut	updateFileShortcut(long userId, long fileShortcutId, long folderId, long toFileEntryId, ServiceContext serviceContext)
void	updateFileShortcuts(long oldToFileEntryId, long newToFileEntryId)
Folder	updateFolder(long folderId, long parentFolderId, java.lang.String name, java.lang.String description, ServiceContext serviceContext)

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

getCapability, isCapabilityProvided

Method Detail

addFileEntry

FileEntry addFileEntry(long userId,
                       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

Throws:

PortalException

addFileEntry

FileEntry addFileEntry(long userId,
                       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

Throws:

PortalException

addFileShortcut

FileShortcut addFileShortcut(long userId,
                             long folderId,
                             long toFileEntryId,
                             ServiceContext serviceContext)
                      throws PortalException

Throws:

PortalException

addFolder

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

Throws:

PortalException

checkInFileEntry

void checkInFileEntry(long userId,
                      long fileEntryId,
                      boolean majorVersion,
                      java.lang.String changeLog,
                      ServiceContext serviceContext)
               throws PortalException

Throws:

PortalException

checkInFileEntry

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

Throws:

PortalException

copyFileEntry

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

Throws:

PortalException

deleteAll

void deleteAll()
        throws PortalException

Throws:

PortalException

deleteFileEntry

void deleteFileEntry(long fileEntryId)
              throws PortalException

Throws:

PortalException

deleteFileShortcut

void deleteFileShortcut(long fileShortcutId)
                 throws PortalException

Throws:

PortalException

deleteFileShortcuts

void deleteFileShortcuts(long toFileEntryId)
                  throws PortalException

Throws:

PortalException

deleteFolder

void deleteFolder(long folderId)
           throws PortalException

Throws:

PortalException

getFileEntries

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

Throws:

PortalException

getFileEntries

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

Throws:

PortalException

getFileEntriesAndFileShortcuts

java.util.List<RepositoryEntry> getFileEntriesAndFileShortcuts(long folderId,
                                                               int status,
                                                               int start,
                                                               int end)
                                                        throws PortalException

Throws:

PortalException

getFileEntriesAndFileShortcutsCount

int getFileEntriesAndFileShortcutsCount(long folderId,
                                        int status)
                                 throws PortalException

Throws:

PortalException

getFileEntriesCount

int getFileEntriesCount(long folderId)
                 throws PortalException

Throws:

PortalException

getFileEntriesCount

int getFileEntriesCount(long folderId,
                        int status)
                 throws PortalException

Throws:

PortalException

getFileEntry

FileEntry getFileEntry(long fileEntryId)
                throws PortalException

Throws:

PortalException

getFileEntry

FileEntry getFileEntry(long folderId,
                       java.lang.String title)
                throws PortalException

Throws:

PortalException

getFileEntryByUuid

FileEntry getFileEntryByUuid(java.lang.String uuid)
                      throws PortalException

Throws:

PortalException

getFileShortcut

FileShortcut getFileShortcut(long fileShortcutId)
                      throws PortalException

Throws:

PortalException

getFileVersion

FileVersion getFileVersion(long fileVersionId)
                    throws PortalException

Throws:

PortalException

getFolder

Folder getFolder(long folderId)
          throws PortalException

Throws:

PortalException

getFolder

Folder getFolder(long parentFolderId,
                 java.lang.String name)
          throws PortalException

Throws:

PortalException

getFolders

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

Throws:

PortalException

getFolders

java.util.List<Folder> getFolders(long parentFolderId,
                                  int status,
                                  boolean includeMountFolders,
                                  int start,
                                  int end,
                                  OrderByComparator<Folder> obc)
                           throws PortalException

Throws:

PortalException

getFoldersAndFileEntriesAndFileShortcuts

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

Throws:

PortalException

getFoldersAndFileEntriesAndFileShortcutsCount

int getFoldersAndFileEntriesAndFileShortcutsCount(long folderId,
                                                  int status,
                                                  boolean includeMountFolders)
                                           throws PortalException

Throws:

PortalException

getFoldersCount

int getFoldersCount(long parentFolderId,
                    boolean includeMountfolders)
             throws PortalException

Throws:

PortalException

getFoldersCount

int getFoldersCount(long parentFolderId,
                    int status,
                    boolean includeMountfolders)
             throws PortalException

Throws:

PortalException

getRepositoryFileEntries

java.util.List<FileEntry> getRepositoryFileEntries(long userId,
                                                   long rootFolderId,
                                                   int start,
                                                   int end,
                                                   OrderByComparator<FileEntry> obc)
                                            throws PortalException

Throws:

PortalException

getRepositoryId

long getRepositoryId()

moveFileEntry

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

Throws:

PortalException

moveFolder

Folder moveFolder(long userId,
                  long folderId,
                  long parentFolderId,
                  ServiceContext serviceContext)
           throws PortalException

Throws:

PortalException

revertFileEntry

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

Throws:

PortalException

updateFileEntry

FileEntry updateFileEntry(long userId,
                          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

Throws:

PortalException

updateFileEntry

FileEntry updateFileEntry(long userId,
                          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

Throws:

PortalException

updateFileShortcut

FileShortcut updateFileShortcut(long userId,
                                long fileShortcutId,
                                long folderId,
                                long toFileEntryId,
                                ServiceContext serviceContext)
                         throws PortalException

Throws:

PortalException

updateFileShortcuts

void updateFileShortcuts(long oldToFileEntryId,
                         long newToFileEntryId)
                  throws PortalException

Throws:

PortalException

updateFolder

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

Throws:

PortalException