com.liferay.documentlibrary.util
Interface Hook

All Known Implementing Classes:
BaseHook

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, java.lang.String properties, byte[] byteArray)
           
 void addFile(long companyId, java.lang.String portletId, long groupId, long repositoryId, java.lang.String fileName, java.lang.String properties, java.io.File file)
           
 void addFile(long companyId, java.lang.String portletId, long groupId, long repositoryId, java.lang.String fileName, java.lang.String properties, 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)
           
 void updateFile(long companyId, java.lang.String portletId, long groupId, long repositoryId, java.lang.String fileName, double versionNumber, java.lang.String sourceFileName, java.lang.String properties, byte[] byteArray)
           
 void updateFile(long companyId, java.lang.String portletId, long groupId, long repositoryId, java.lang.String fileName, double versionNumber, java.lang.String sourceFileName, java.lang.String properties, 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, java.lang.String properties, java.io.InputStream is)
           
 

Field Detail

DEFAULT_VERSION

public static final double DEFAULT_VERSION
See Also:
Constant Field Values
Method Detail

addDirectory

public 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

public void addFile(long companyId,
                    java.lang.String portletId,
                    long groupId,
                    long repositoryId,
                    java.lang.String fileName,
                    java.lang.String properties,
                    java.io.File file)
             throws com.liferay.portal.PortalException,
                    com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

addFile

public void addFile(long companyId,
                    java.lang.String portletId,
                    long groupId,
                    long repositoryId,
                    java.lang.String fileName,
                    java.lang.String properties,
                    byte[] byteArray)
             throws com.liferay.portal.PortalException,
                    com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

addFile

public void addFile(long companyId,
                    java.lang.String portletId,
                    long groupId,
                    long repositoryId,
                    java.lang.String fileName,
                    java.lang.String properties,
                    java.io.InputStream is)
             throws com.liferay.portal.PortalException,
                    com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

checkRoot

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

deleteDirectory

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

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

reIndex

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

updateFile

public void updateFile(long companyId,
                       java.lang.String portletId,
                       long groupId,
                       long repositoryId,
                       java.lang.String fileName,
                       double versionNumber,
                       java.lang.String sourceFileName,
                       java.lang.String properties,
                       java.io.File file)
                throws com.liferay.portal.PortalException,
                       com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

updateFile

public void updateFile(long companyId,
                       java.lang.String portletId,
                       long groupId,
                       long repositoryId,
                       java.lang.String fileName,
                       double versionNumber,
                       java.lang.String sourceFileName,
                       java.lang.String properties,
                       byte[] byteArray)
                throws com.liferay.portal.PortalException,
                       com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

updateFile

public void updateFile(long companyId,
                       java.lang.String portletId,
                       long groupId,
                       long repositoryId,
                       java.lang.String fileName,
                       double versionNumber,
                       java.lang.String sourceFileName,
                       java.lang.String properties,
                       java.io.InputStream is)
                throws com.liferay.portal.PortalException,
                       com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

updateFile

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