Liferay 7.0-ce-b4

com.liferay.portal.kernel.repository
Interface DocumentRepository

All Superinterfaces:
CapabilityProvider
All Known Subinterfaces:
BaseRepository, LocalRepository, Repository
All Known Implementing Classes:
BaseCapabilityRepository, BaseRepositoryImpl, BaseRepositoryProxyBean, CapabilityLocalRepository, CapabilityRepository, DefaultLocalRepositoryImpl, InitializedDocumentRepository, InitializedLocalRepository, InitializedRepository, LiferayLocalRepository, LiferayProcessorLocalRepositoryWrapper, LiferayProcessorRepositoryWrapper, LiferayRepository, LiferayWorkflowLocalRepositoryWrapper, LiferayWorkflowRepositoryWrapper, LocalRepositoryProxyBean, LocalRepositoryWrapper, ModelValidatorLocalRepositoryWrapper, ModelValidatorRepositoryWrapper, PortletRepository, RepositoryWrapper, TemporaryFileEntryRepository

public interface DocumentRepository
extends CapabilityProvider


Method Summary
 FileEntry addFileEntry(long userId, long folderId, String sourceFileName, String mimeType, String title, String description, String changeLog, File file, ServiceContext serviceContext)
           
 FileEntry addFileEntry(long userId, long folderId, String sourceFileName, String mimeType, String title, String description, String changeLog, InputStream is, long size, ServiceContext serviceContext)
           
 FileShortcut addFileShortcut(long userId, long folderId, long toFileEntryId, ServiceContext serviceContext)
           
 Folder addFolder(long userId, long parentFolderId, String name, String description, ServiceContext serviceContext)
           
 void checkInFileEntry(long userId, long fileEntryId, boolean major, String changeLog, ServiceContext serviceContext)
           
 void checkInFileEntry(long userId, long fileEntryId, 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)
           
 List<FileEntry> getFileEntries(long folderId, int status, int start, int end, OrderByComparator<FileEntry> obc)
           
 List<FileEntry> getFileEntries(long folderId, int start, int end, OrderByComparator<FileEntry> obc)
           
 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, String title)
           
 FileEntry getFileEntryByUuid(String uuid)
           
 FileShortcut getFileShortcut(long fileShortcutId)
           
 FileVersion getFileVersion(long fileVersionId)
           
 Folder getFolder(long folderId)
           
 Folder getFolder(long parentFolderId, String name)
           
 List<Folder> getFolders(long parentFolderId, boolean includeMountFolders, int start, int end, OrderByComparator<Folder> obc)
           
 List<Folder> getFolders(long parentFolderId, int status, boolean includeMountFolders, int start, int end, OrderByComparator<Folder> obc)
           
 List<RepositoryEntry> getFoldersAndFileEntriesAndFileShortcuts(long folderId, int status, boolean includeMountFolders, int start, int end, OrderByComparator<?> obc)
           
 int getFoldersCount(long parentFolderId, boolean includeMountfolders)
           
 int getFoldersCount(long parentFolderId, int status, boolean includeMountfolders)
           
 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, String version, ServiceContext serviceContext)
           
 FileEntry updateFileEntry(long userId, long fileEntryId, String sourceFileName, String mimeType, String title, String description, String changeLog, boolean majorVersion, File file, ServiceContext serviceContext)
           
 FileEntry updateFileEntry(long userId, long fileEntryId, String sourceFileName, String mimeType, String title, String description, String changeLog, boolean majorVersion, 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, String name, 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,
                       String sourceFileName,
                       String mimeType,
                       String title,
                       String description,
                       String changeLog,
                       File file,
                       ServiceContext serviceContext)
                       throws PortalException
Throws:
PortalException

addFileEntry

FileEntry addFileEntry(long userId,
                       long folderId,
                       String sourceFileName,
                       String mimeType,
                       String title,
                       String description,
                       String changeLog,
                       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,
                 String name,
                 String description,
                 ServiceContext serviceContext)
                 throws PortalException
Throws:
PortalException

checkInFileEntry

void checkInFileEntry(long userId,
                      long fileEntryId,
                      boolean major,
                      String changeLog,
                      ServiceContext serviceContext)
                      throws PortalException
Throws:
PortalException

checkInFileEntry

void checkInFileEntry(long userId,
                      long fileEntryId,
                      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

List<FileEntry> getFileEntries(long folderId,
                               int status,
                               int start,
                               int end,
                               OrderByComparator<FileEntry> obc)
                               throws PortalException
Throws:
PortalException

getFileEntries

List<FileEntry> getFileEntries(long folderId,
                               int start,
                               int end,
                               OrderByComparator<FileEntry> obc)
                               throws PortalException
Throws:
PortalException

getFileEntriesAndFileShortcuts

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,
                       String title)
                       throws PortalException
Throws:
PortalException

getFileEntryByUuid

FileEntry getFileEntryByUuid(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,
                 String name)
                 throws PortalException
Throws:
PortalException

getFolders

List<Folder> getFolders(long parentFolderId,
                        boolean includeMountFolders,
                        int start,
                        int end,
                        OrderByComparator<Folder> obc)
                        throws PortalException
Throws:
PortalException

getFolders

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

getFoldersAndFileEntriesAndFileShortcuts

List<RepositoryEntry> getFoldersAndFileEntriesAndFileShortcuts(long folderId,
                                                               int status,
                                                               boolean includeMountFolders,
                                                               int start,
                                                               int end,
                                                               OrderByComparator<?> obc)
                                                               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

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,
                     String version,
                     ServiceContext serviceContext)
                     throws PortalException
Throws:
PortalException

updateFileEntry

FileEntry updateFileEntry(long userId,
                          long fileEntryId,
                          String sourceFileName,
                          String mimeType,
                          String title,
                          String description,
                          String changeLog,
                          boolean majorVersion,
                          File file,
                          ServiceContext serviceContext)
                          throws PortalException
Throws:
PortalException

updateFileEntry

FileEntry updateFileEntry(long userId,
                          long fileEntryId,
                          String sourceFileName,
                          String mimeType,
                          String title,
                          String description,
                          String changeLog,
                          boolean majorVersion,
                          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,
                    String name,
                    String description,
                    ServiceContext serviceContext)
                    throws PortalException
Throws:
PortalException

Liferay 7.0-ce-b4