com.liferay.documentlibrary.util
Interface Hook

All Known Implementing Classes:
BaseHook, HookWrapper

@MessagingProxy(mode=SYNC)
public interface Hook


Field Summary
static java.lang.String 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, ServiceContext serviceContext, 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, ServiceContext serviceContext, 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, ServiceContext serviceContext, 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, java.lang.String versionNumber)
           
 byte[] getFile(long companyId, long repositoryId, java.lang.String fileName)
           
 byte[] getFile(long companyId, long repositoryId, java.lang.String fileName, java.lang.String 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, java.lang.String 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, java.lang.String 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, java.lang.String newFileName, boolean reindex)
           
 void updateFile(long companyId, java.lang.String portletId, long groupId, long repositoryId, java.lang.String fileName, java.lang.String versionNumber, java.lang.String sourceFileName, long fileEntryId, java.lang.String properties, java.util.Date modifiedDate, ServiceContext serviceContext, byte[] bytes)
           
 void updateFile(long companyId, java.lang.String portletId, long groupId, long repositoryId, java.lang.String fileName, java.lang.String versionNumber, java.lang.String sourceFileName, long fileEntryId, java.lang.String properties, java.util.Date modifiedDate, ServiceContext serviceContext, java.io.File file)
           
 void updateFile(long companyId, java.lang.String portletId, long groupId, long repositoryId, java.lang.String fileName, java.lang.String versionNumber, java.lang.String sourceFileName, long fileEntryId, java.lang.String properties, java.util.Date modifiedDate, ServiceContext serviceContext, java.io.InputStream is)
           
 

Field Detail

DEFAULT_VERSION

static final java.lang.String DEFAULT_VERSION
See Also:
Constant Field Values
Method Detail

addDirectory

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

addFile

@MessagingProxy(mode=ASYNC)
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,
                            ServiceContext serviceContext,
                            byte[] bytes)
             throws com.liferay.portal.kernel.exception.PortalException,
                    com.liferay.portal.kernel.exception.SystemException
Throws:
com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.SystemException

addFile

@MessagingProxy(mode=ASYNC)
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,
                            ServiceContext serviceContext,
                            java.io.File file)
             throws com.liferay.portal.kernel.exception.PortalException,
                    com.liferay.portal.kernel.exception.SystemException
Throws:
com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.SystemException

addFile

@MessagingProxy(mode=ASYNC)
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,
                            ServiceContext serviceContext,
                            java.io.InputStream is)
             throws com.liferay.portal.kernel.exception.PortalException,
                    com.liferay.portal.kernel.exception.SystemException
Throws:
com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.SystemException

checkRoot

void checkRoot(long companyId)
               throws com.liferay.portal.kernel.exception.SystemException
Throws:
com.liferay.portal.kernel.exception.SystemException

deleteDirectory

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

deleteFile

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

deleteFile

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

getFile

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

getFile

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

getFileAsStream

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

getFileAsStream

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

getFileNames

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

getFileSize

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

hasFile

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

move

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

reindex

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

updateFile

@MessagingProxy(mode=ASYNC)
void updateFile(long companyId,
                               java.lang.String portletId,
                               long groupId,
                               long repositoryId,
                               long newRepositoryId,
                               java.lang.String fileName,
                               long fileEntryId)
                throws com.liferay.portal.kernel.exception.PortalException,
                       com.liferay.portal.kernel.exception.SystemException
Throws:
com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.SystemException

updateFile

@MessagingProxy(mode=ASYNC)
void updateFile(long companyId,
                               java.lang.String portletId,
                               long groupId,
                               long repositoryId,
                               java.lang.String fileName,
                               java.lang.String versionNumber,
                               java.lang.String sourceFileName,
                               long fileEntryId,
                               java.lang.String properties,
                               java.util.Date modifiedDate,
                               ServiceContext serviceContext,
                               byte[] bytes)
                throws com.liferay.portal.kernel.exception.PortalException,
                       com.liferay.portal.kernel.exception.SystemException
Throws:
com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.SystemException

updateFile

@MessagingProxy(mode=ASYNC)
void updateFile(long companyId,
                               java.lang.String portletId,
                               long groupId,
                               long repositoryId,
                               java.lang.String fileName,
                               java.lang.String versionNumber,
                               java.lang.String sourceFileName,
                               long fileEntryId,
                               java.lang.String properties,
                               java.util.Date modifiedDate,
                               ServiceContext serviceContext,
                               java.io.File file)
                throws com.liferay.portal.kernel.exception.PortalException,
                       com.liferay.portal.kernel.exception.SystemException
Throws:
com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.SystemException

updateFile

@MessagingProxy(mode=ASYNC)
void updateFile(long companyId,
                               java.lang.String portletId,
                               long groupId,
                               long repositoryId,
                               java.lang.String fileName,
                               java.lang.String versionNumber,
                               java.lang.String sourceFileName,
                               long fileEntryId,
                               java.lang.String properties,
                               java.util.Date modifiedDate,
                               ServiceContext serviceContext,
                               java.io.InputStream is)
                throws com.liferay.portal.kernel.exception.PortalException,
                       com.liferay.portal.kernel.exception.SystemException
Throws:
com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.SystemException

updateFile

@MessagingProxy(mode=ASYNC)
void updateFile(long companyId,
                               java.lang.String portletId,
                               long groupId,
                               long repositoryId,
                               java.lang.String fileName,
                               java.lang.String newFileName,
                               boolean reindex)
                throws com.liferay.portal.kernel.exception.PortalException,
                       com.liferay.portal.kernel.exception.SystemException
Throws:
com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.SystemException