com.liferay.documentlibrary.util
Interface Hook

All Known Implementing Classes:

AdvancedFileSystemHook, BaseHook, CMISHook, FileSystemHook, HookProxyBean, HookProxyImpl, HookWrapper, JCRHook, S3Hook, SafeFileNameHookWrapper

public interface Hook

Field Summary

static String

DEFAULT_VERSION

Method Summary

void	addDirectory(long companyId, long repositoryId, String dirName)
void	addFile(long companyId, String portletId, long groupId, long repositoryId, String fileName, long fileEntryId, String properties, Date modifiedDate, ServiceContext serviceContext, byte[] bytes)
void	addFile(long companyId, String portletId, long groupId, long repositoryId, String fileName, long fileEntryId, String properties, Date modifiedDate, ServiceContext serviceContext, File file)
void	addFile(long companyId, String portletId, long groupId, long repositoryId, String fileName, long fileEntryId, String properties, Date modifiedDate, ServiceContext serviceContext, InputStream is)
void	checkRoot(long companyId)
void	deleteDirectory(long companyId, String portletId, long repositoryId, String dirName)
void	deleteFile(long companyId, String portletId, long repositoryId, String fileName)
void	deleteFile(long companyId, String portletId, long repositoryId, String fileName, String versionNumber)
byte[]	getFile(long companyId, long repositoryId, String fileName)
byte[]	getFile(long companyId, long repositoryId, String fileName, String versionNumber)
InputStream	getFileAsStream(long companyId, long repositoryId, String fileName)
InputStream	getFileAsStream(long companyId, long repositoryId, String fileName, String versionNumber)
String[]	getFileNames(long companyId, long repositoryId, String dirName)
long	getFileSize(long companyId, long repositoryId, String fileName)
boolean	hasFile(long companyId, long repositoryId, String fileName, String versionNumber)
void	move(String srcDir, String destDir)
void	reindex(String[] ids)
void	updateFile(long companyId, String portletId, long groupId, long repositoryId, long newRepositoryId, String fileName, long fileEntryId)
void	updateFile(long companyId, String portletId, long groupId, long repositoryId, String fileName, String newFileName, boolean reindex)
void	updateFile(long companyId, String portletId, long groupId, long repositoryId, String fileName, String versionNumber, String sourceFileName, long fileEntryId, String properties, Date modifiedDate, ServiceContext serviceContext, byte[] bytes)
void	updateFile(long companyId, String portletId, long groupId, long repositoryId, String fileName, String versionNumber, String sourceFileName, long fileEntryId, String properties, Date modifiedDate, ServiceContext serviceContext, File file)
void	updateFile(long companyId, String portletId, long groupId, long repositoryId, String fileName, String versionNumber, String sourceFileName, long fileEntryId, String properties, Date modifiedDate, ServiceContext serviceContext, InputStream is)

Field Detail

DEFAULT_VERSION

static final String DEFAULT_VERSION

See Also:

Constant Field Values

Method Detail

addDirectory

void addDirectory(long companyId,
                  long repositoryId,
                  String dirName)
                  throws PortalException,
                         SystemException

Throws:

PortalException

SystemException

addFile

void addFile(long companyId,
             String portletId,
             long groupId,
             long repositoryId,
             String fileName,
             long fileEntryId,
             String properties,
             Date modifiedDate,
             ServiceContext serviceContext,
             byte[] bytes)
             throws PortalException,
                    SystemException

Throws:

PortalException

SystemException

addFile

void addFile(long companyId,
             String portletId,
             long groupId,
             long repositoryId,
             String fileName,
             long fileEntryId,
             String properties,
             Date modifiedDate,
             ServiceContext serviceContext,
             File file)
             throws PortalException,
                    SystemException

Throws:

PortalException

SystemException

addFile

void addFile(long companyId,
             String portletId,
             long groupId,
             long repositoryId,
             String fileName,
             long fileEntryId,
             String properties,
             Date modifiedDate,
             ServiceContext serviceContext,
             InputStream is)
             throws PortalException,
                    SystemException

Throws:

PortalException

SystemException

checkRoot

void checkRoot(long companyId)
               throws SystemException

Throws:

SystemException

deleteDirectory

void deleteDirectory(long companyId,
                     String portletId,
                     long repositoryId,
                     String dirName)
                     throws PortalException,
                            SystemException

Throws:

PortalException

SystemException

deleteFile

void deleteFile(long companyId,
                String portletId,
                long repositoryId,
                String fileName)
                throws PortalException,
                       SystemException

Throws:

PortalException

SystemException

deleteFile

void deleteFile(long companyId,
                String portletId,
                long repositoryId,
                String fileName,
                String versionNumber)
                throws PortalException,
                       SystemException

Throws:

PortalException

SystemException

getFile

byte[] getFile(long companyId,
               long repositoryId,
               String fileName)
               throws PortalException,
                      SystemException

Throws:

PortalException

SystemException

getFile

byte[] getFile(long companyId,
               long repositoryId,
               String fileName,
               String versionNumber)
               throws PortalException,
                      SystemException

Throws:

PortalException

SystemException

getFileAsStream

InputStream getFileAsStream(long companyId,
                            long repositoryId,
                            String fileName)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

getFileAsStream

InputStream getFileAsStream(long companyId,
                            long repositoryId,
                            String fileName,
                            String versionNumber)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

getFileNames

String[] getFileNames(long companyId,
                      long repositoryId,
                      String dirName)
                      throws PortalException,
                             SystemException

Throws:

PortalException

SystemException

getFileSize

long getFileSize(long companyId,
                 long repositoryId,
                 String fileName)
                 throws PortalException,
                        SystemException

Throws:

PortalException

SystemException

hasFile

boolean hasFile(long companyId,
                long repositoryId,
                String fileName,
                String versionNumber)
                throws PortalException,
                       SystemException

Throws:

PortalException

SystemException

move

void move(String srcDir,
          String destDir)
          throws SystemException

Throws:

SystemException

reindex

void reindex(String[] ids)
             throws SearchException

Throws:

SearchException

updateFile

void updateFile(long companyId,
                String portletId,
                long groupId,
                long repositoryId,
                long newRepositoryId,
                String fileName,
                long fileEntryId)
                throws PortalException,
                       SystemException

Throws:

PortalException

SystemException

updateFile

void updateFile(long companyId,
                String portletId,
                long groupId,
                long repositoryId,
                String fileName,
                String newFileName,
                boolean reindex)
                throws PortalException,
                       SystemException

Throws:

PortalException

SystemException

updateFile

void updateFile(long companyId,
                String portletId,
                long groupId,
                long repositoryId,
                String fileName,
                String versionNumber,
                String sourceFileName,
                long fileEntryId,
                String properties,
                Date modifiedDate,
                ServiceContext serviceContext,
                byte[] bytes)
                throws PortalException,
                       SystemException

Throws:

PortalException

SystemException

updateFile

void updateFile(long companyId,
                String portletId,
                long groupId,
                long repositoryId,
                String fileName,
                String versionNumber,
                String sourceFileName,
                long fileEntryId,
                String properties,
                Date modifiedDate,
                ServiceContext serviceContext,
                File file)
                throws PortalException,
                       SystemException

Throws:

PortalException

SystemException

updateFile

void updateFile(long companyId,
                String portletId,
                long groupId,
                long repositoryId,
                String fileName,
                String versionNumber,
                String sourceFileName,
                long fileEntryId,
                String properties,
                Date modifiedDate,
                ServiceContext serviceContext,
                InputStream is)
                throws PortalException,
                       SystemException

Throws:

PortalException

SystemException