com.liferay.documentlibrary.util
Interface Hook

All Known Implementing Classes:

BaseHook, FileSystemHook, JCRHook, S3Hook

public interface Hook

View Source

Author:

Brian Wing Shun Chan

Field Summary

static double

DEFAULT_VERSION

Method Summary

void	addDirectory(long companyId, long repositoryId, java.lang.String dirName)
void	addFile(long companyId, java.lang.String portletId, long groupId, long repositoryId, java.lang.String fileName, long fileEntryId, java.lang.String properties, java.util.Date modifiedDate, java.lang.String[] tagsEntries, byte[] bytes)
void	addFile(long companyId, java.lang.String portletId, long groupId, long repositoryId, java.lang.String fileName, long fileEntryId, java.lang.String properties, java.util.Date modifiedDate, java.lang.String[] tagsEntries, java.io.File file)
void	addFile(long companyId, java.lang.String portletId, long groupId, long repositoryId, java.lang.String fileName, long fileEntryId, java.lang.String properties, java.util.Date modifiedDate, java.lang.String[] tagsEntries, java.io.InputStream is)
void	checkRoot(long companyId)
void	deleteDirectory(long companyId, java.lang.String portletId, long repositoryId, java.lang.String dirName)
void	deleteFile(long companyId, java.lang.String portletId, long repositoryId, java.lang.String fileName)
void	deleteFile(long companyId, java.lang.String portletId, long repositoryId, java.lang.String fileName, double versionNumber)
byte[]	getFile(long companyId, long repositoryId, java.lang.String fileName)
byte[]	getFile(long companyId, long repositoryId, java.lang.String fileName, double versionNumber)
java.io.InputStream	getFileAsStream(long companyId, long repositoryId, java.lang.String fileName)
java.io.InputStream	getFileAsStream(long companyId, long repositoryId, java.lang.String fileName, double versionNumber)
java.lang.String[]	getFileNames(long companyId, long repositoryId, java.lang.String dirName)
long	getFileSize(long companyId, long repositoryId, java.lang.String fileName)
boolean	hasFile(long companyId, long repositoryId, java.lang.String fileName, double versionNumber)
void	move(java.lang.String srcDir, java.lang.String destDir)
void	reIndex(java.lang.String[] ids)
void	updateFile(long companyId, java.lang.String portletId, long groupId, long repositoryId, long newRepositoryId, java.lang.String fileName, long fileEntryId)
void	updateFile(long companyId, java.lang.String portletId, long groupId, long repositoryId, java.lang.String fileName, double versionNumber, java.lang.String sourceFileName, long fileEntryId, java.lang.String properties, java.util.Date modifiedDate, java.lang.String[] tagsEntries, byte[] bytes)
void	updateFile(long companyId, java.lang.String portletId, long groupId, long repositoryId, java.lang.String fileName, double versionNumber, java.lang.String sourceFileName, long fileEntryId, java.lang.String properties, java.util.Date modifiedDate, java.lang.String[] tagsEntries, java.io.File file)
void	updateFile(long companyId, java.lang.String portletId, long groupId, long repositoryId, java.lang.String fileName, double versionNumber, java.lang.String sourceFileName, long fileEntryId, java.lang.String properties, java.util.Date modifiedDate, java.lang.String[] tagsEntries, java.io.InputStream is)

Field Detail

DEFAULT_VERSION

static final double DEFAULT_VERSION

See Also:

Constant Field Values

Method Detail

addDirectory

void addDirectory(long companyId,
                  long repositoryId,
                  java.lang.String dirName)
                  throws com.liferay.portal.PortalException,
                         com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

addFile

void addFile(long companyId,
             java.lang.String portletId,
             long groupId,
             long repositoryId,
             java.lang.String fileName,
             long fileEntryId,
             java.lang.String properties,
             java.util.Date modifiedDate,
             java.lang.String[] tagsEntries,
             byte[] bytes)
             throws com.liferay.portal.PortalException,
                    com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

addFile

void addFile(long companyId,
             java.lang.String portletId,
             long groupId,
             long repositoryId,
             java.lang.String fileName,
             long fileEntryId,
             java.lang.String properties,
             java.util.Date modifiedDate,
             java.lang.String[] tagsEntries,
             java.io.File file)
             throws com.liferay.portal.PortalException,
                    com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

addFile

void addFile(long companyId,
             java.lang.String portletId,
             long groupId,
             long repositoryId,
             java.lang.String fileName,
             long fileEntryId,
             java.lang.String properties,
             java.util.Date modifiedDate,
             java.lang.String[] tagsEntries,
             java.io.InputStream is)
             throws com.liferay.portal.PortalException,
                    com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

checkRoot

void checkRoot(long companyId)
               throws com.liferay.portal.SystemException

Throws:

com.liferay.portal.SystemException

deleteDirectory

void deleteDirectory(long companyId,
                     java.lang.String portletId,
                     long repositoryId,
                     java.lang.String dirName)
                     throws com.liferay.portal.PortalException,
                            com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

deleteFile

void deleteFile(long companyId,
                java.lang.String portletId,
                long repositoryId,
                java.lang.String fileName)
                throws com.liferay.portal.PortalException,
                       com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

deleteFile

void deleteFile(long companyId,
                java.lang.String portletId,
                long repositoryId,
                java.lang.String fileName,
                double versionNumber)
                throws com.liferay.portal.PortalException,
                       com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getFile

byte[] getFile(long companyId,
               long repositoryId,
               java.lang.String fileName)
               throws com.liferay.portal.PortalException,
                      com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getFile

byte[] getFile(long companyId,
               long repositoryId,
               java.lang.String fileName,
               double versionNumber)
               throws com.liferay.portal.PortalException,
                      com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getFileAsStream

java.io.InputStream getFileAsStream(long companyId,
                                    long repositoryId,
                                    java.lang.String fileName)
                                    throws com.liferay.portal.PortalException,
                                           com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getFileAsStream

java.io.InputStream getFileAsStream(long companyId,
                                    long repositoryId,
                                    java.lang.String fileName,
                                    double versionNumber)
                                    throws com.liferay.portal.PortalException,
                                           com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getFileNames

java.lang.String[] getFileNames(long companyId,
                                long repositoryId,
                                java.lang.String dirName)
                                throws com.liferay.portal.PortalException,
                                       com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getFileSize

long getFileSize(long companyId,
                 long repositoryId,
                 java.lang.String fileName)
                 throws com.liferay.portal.PortalException,
                        com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

hasFile

boolean hasFile(long companyId,
                long repositoryId,
                java.lang.String fileName,
                double versionNumber)
                throws com.liferay.portal.PortalException,
                       com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

move

void move(java.lang.String srcDir,
          java.lang.String destDir)
          throws com.liferay.portal.SystemException

Throws:

com.liferay.portal.SystemException

reIndex

void reIndex(java.lang.String[] ids)
             throws com.liferay.portal.kernel.search.SearchException

Throws:

com.liferay.portal.kernel.search.SearchException

updateFile

void updateFile(long companyId,
                java.lang.String portletId,
                long groupId,
                long repositoryId,
                java.lang.String fileName,
                double versionNumber,
                java.lang.String sourceFileName,
                long fileEntryId,
                java.lang.String properties,
                java.util.Date modifiedDate,
                java.lang.String[] tagsEntries,
                byte[] bytes)
                throws com.liferay.portal.PortalException,
                       com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

updateFile

void updateFile(long companyId,
                java.lang.String portletId,
                long groupId,
                long repositoryId,
                java.lang.String fileName,
                double versionNumber,
                java.lang.String sourceFileName,
                long fileEntryId,
                java.lang.String properties,
                java.util.Date modifiedDate,
                java.lang.String[] tagsEntries,
                java.io.File file)
                throws com.liferay.portal.PortalException,
                       com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

updateFile

void updateFile(long companyId,
                java.lang.String portletId,
                long groupId,
                long repositoryId,
                java.lang.String fileName,
                double versionNumber,
                java.lang.String sourceFileName,
                long fileEntryId,
                java.lang.String properties,
                java.util.Date modifiedDate,
                java.lang.String[] tagsEntries,
                java.io.InputStream is)
                throws com.liferay.portal.PortalException,
                       com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

updateFile

void updateFile(long companyId,
                java.lang.String portletId,
                long groupId,
                long repositoryId,
                long newRepositoryId,
                java.lang.String fileName,
                long fileEntryId)
                throws com.liferay.portal.PortalException,
                       com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException