com.liferay.portlet.documentlibrary.service
Interface DLFileEntryService

All Known Implementing Classes:
DLFileEntryServiceWrapper

@Transactional(isolation=PORTAL,
               rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class})
public interface DLFileEntryService

View Source

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

This interface defines the service. The default implementation is com.liferay.portlet.documentlibrary.service.impl.DLFileEntryServiceImpl}. Modify methods in that class and rerun ServiceBuilder to populate this class and all other generated classes.

This is a remote service. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.

Author:
Brian Wing Shun Chan
See Also:
DLFileEntryServiceUtil
Generated:

Method Summary
 DLFileEntry addFileEntry(long groupId, long folderId, java.lang.String name, java.lang.String title, java.lang.String description, java.lang.String versionDescription, java.lang.String extraSettings, byte[] bytes, ServiceContext serviceContext)
           
 DLFileEntry addFileEntry(long groupId, long folderId, java.lang.String name, java.lang.String title, java.lang.String description, java.lang.String versionDescription, java.lang.String extraSettings, java.io.File file, ServiceContext serviceContext)
           
 void deleteFileEntry(long groupId, long folderId, java.lang.String name)
           
 void deleteFileEntry(long groupId, long folderId, java.lang.String name, java.lang.String version)
           
 void deleteFileEntryByTitle(long groupId, long folderId, java.lang.String titleWithExtension)
           
 java.util.List<DLFileEntry> getFileEntries(long groupId, long folderId)
           
 DLFileEntry getFileEntry(long groupId, long folderId, java.lang.String name)
           
 DLFileEntry getFileEntryByTitle(long groupId, long folderId, java.lang.String titleWithExtension)
           
 boolean hasFileEntryLock(long groupId, long folderId, java.lang.String name)
           
 Lock lockFileEntry(long groupId, long folderId, java.lang.String name)
           
 Lock lockFileEntry(long groupId, long folderId, java.lang.String name, java.lang.String owner, long expirationTime)
           
 Lock refreshFileEntryLock(java.lang.String lockUuid, long expirationTime)
           
 void unlockFileEntry(long groupId, long folderId, java.lang.String name)
           
 void unlockFileEntry(long groupId, long folderId, java.lang.String name, java.lang.String lockUuid)
           
 DLFileEntry updateFileEntry(long groupId, long folderId, long newFolderId, java.lang.String name, java.lang.String sourceFileName, java.lang.String title, java.lang.String description, java.lang.String versionDescription, boolean majorVersion, java.lang.String extraSettings, byte[] bytes, ServiceContext serviceContext)
           
 DLFileEntry updateFileEntry(long groupId, long folderId, long newFolderId, java.lang.String name, java.lang.String sourceFileName, java.lang.String title, java.lang.String description, java.lang.String versionDescription, boolean majorVersion, java.lang.String extraSettings, java.io.File file, ServiceContext serviceContext)
           
 boolean verifyFileEntryLock(long groupId, long folderId, java.lang.String name, java.lang.String lockUuid)
           
 

Method Detail

addFileEntry

DLFileEntry addFileEntry(long groupId,
                         long folderId,
                         java.lang.String name,
                         java.lang.String title,
                         java.lang.String description,
                         java.lang.String versionDescription,
                         java.lang.String extraSettings,
                         byte[] bytes,
                         ServiceContext serviceContext)
                         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

addFileEntry

DLFileEntry addFileEntry(long groupId,
                         long folderId,
                         java.lang.String name,
                         java.lang.String title,
                         java.lang.String description,
                         java.lang.String versionDescription,
                         java.lang.String extraSettings,
                         java.io.File file,
                         ServiceContext serviceContext)
                         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

deleteFileEntry

void deleteFileEntry(long groupId,
                     long folderId,
                     java.lang.String name)
                     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

deleteFileEntry

void deleteFileEntry(long groupId,
                     long folderId,
                     java.lang.String name,
                     java.lang.String version)
                     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

deleteFileEntryByTitle

void deleteFileEntryByTitle(long groupId,
                            long folderId,
                            java.lang.String titleWithExtension)
                            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

getFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DLFileEntry> getFileEntries(long groupId,
                                                         long folderId)
                                           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

getFileEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileEntry getFileEntry(long groupId,
                                       long folderId,
                                       java.lang.String name)
                         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

getFileEntryByTitle

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileEntry getFileEntryByTitle(long groupId,
                                              long folderId,
                                              java.lang.String titleWithExtension)
                                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

hasFileEntryLock

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasFileEntryLock(long groupId,
                                       long folderId,
                                       java.lang.String name)
                         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

lockFileEntry

Lock lockFileEntry(long groupId,
                   long folderId,
                   java.lang.String name)
                   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

lockFileEntry

Lock lockFileEntry(long groupId,
                   long folderId,
                   java.lang.String name,
                   java.lang.String owner,
                   long expirationTime)
                   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

refreshFileEntryLock

Lock refreshFileEntryLock(java.lang.String lockUuid,
                          long expirationTime)
                          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

unlockFileEntry

void unlockFileEntry(long groupId,
                     long folderId,
                     java.lang.String name)
                     throws com.liferay.portal.kernel.exception.SystemException
Throws:
com.liferay.portal.kernel.exception.SystemException

unlockFileEntry

void unlockFileEntry(long groupId,
                     long folderId,
                     java.lang.String name,
                     java.lang.String lockUuid)
                     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

updateFileEntry

DLFileEntry updateFileEntry(long groupId,
                            long folderId,
                            long newFolderId,
                            java.lang.String name,
                            java.lang.String sourceFileName,
                            java.lang.String title,
                            java.lang.String description,
                            java.lang.String versionDescription,
                            boolean majorVersion,
                            java.lang.String extraSettings,
                            byte[] bytes,
                            ServiceContext serviceContext)
                            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

updateFileEntry

DLFileEntry updateFileEntry(long groupId,
                            long folderId,
                            long newFolderId,
                            java.lang.String name,
                            java.lang.String sourceFileName,
                            java.lang.String title,
                            java.lang.String description,
                            java.lang.String versionDescription,
                            boolean majorVersion,
                            java.lang.String extraSettings,
                            java.io.File file,
                            ServiceContext serviceContext)
                            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

verifyFileEntryLock

boolean verifyFileEntryLock(long groupId,
                            long folderId,
                            java.lang.String name,
                            java.lang.String lockUuid)
                            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