com.liferay.portlet.documentlibrary.service
Interface DLFileEntryService


@Transactional(isolation=PORTAL,
               rollbackFor={com.liferay.portal.PortalException.class,com.liferay.portal.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

Method Summary
 DLFileEntry addFileEntry(long folderId, java.lang.String name, java.lang.String title, java.lang.String description, java.lang.String[] tagsEntries, java.lang.String extraSettings, byte[] bytes, boolean addCommunityPermissions, boolean addGuestPermissions)
           
 DLFileEntry addFileEntry(long folderId, java.lang.String name, java.lang.String title, java.lang.String description, java.lang.String[] tagsEntries, java.lang.String extraSettings, byte[] bytes, java.lang.String[] communityPermissions, java.lang.String[] guestPermissions)
           
 DLFileEntry addFileEntry(long folderId, java.lang.String name, java.lang.String title, java.lang.String description, java.lang.String[] tagsEntries, java.lang.String extraSettings, java.io.File file, boolean addCommunityPermissions, boolean addGuestPermissions)
           
 DLFileEntry addFileEntry(long folderId, java.lang.String name, java.lang.String title, java.lang.String description, java.lang.String[] tagsEntries, java.lang.String extraSettings, java.io.File file, java.lang.String[] communityPermissions, java.lang.String[] guestPermissions)
           
 void deleteFileEntry(long folderId, java.lang.String name)
           
 void deleteFileEntry(long folderId, java.lang.String name, double version)
           
 void deleteFileEntryByTitle(long folderId, java.lang.String titleWithExtension)
           
 java.util.List<DLFileEntry> getFileEntries(long folderId)
           
 DLFileEntry getFileEntry(long folderId, java.lang.String name)
           
 DLFileEntry getFileEntryByTitle(long folderId, java.lang.String titleWithExtension)
           
 Lock getFileEntryLock(long folderId, java.lang.String name)
           
 Lock lockFileEntry(long folderId, java.lang.String name)
           
 Lock lockFileEntry(long folderId, java.lang.String name, java.lang.String owner, long expirationTime)
           
 Lock refreshFileEntryLock(java.lang.String lockUuid, long expirationTime)
           
 void unlockFileEntry(long folderId, java.lang.String name)
           
 void unlockFileEntry(long folderId, java.lang.String name, java.lang.String lockUuid)
           
 DLFileEntry updateFileEntry(long folderId, long newFolderId, java.lang.String name, java.lang.String sourceFileName, java.lang.String title, java.lang.String description, java.lang.String[] tagsEntries, java.lang.String extraSettings, byte[] bytes)
           
 

Method Detail

addFileEntry

DLFileEntry addFileEntry(long folderId,
                         java.lang.String name,
                         java.lang.String title,
                         java.lang.String description,
                         java.lang.String[] tagsEntries,
                         java.lang.String extraSettings,
                         java.io.File file,
                         boolean addCommunityPermissions,
                         boolean addGuestPermissions)
                         throws java.rmi.RemoteException,
                                com.liferay.portal.PortalException,
                                com.liferay.portal.SystemException
Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException

addFileEntry

DLFileEntry addFileEntry(long folderId,
                         java.lang.String name,
                         java.lang.String title,
                         java.lang.String description,
                         java.lang.String[] tagsEntries,
                         java.lang.String extraSettings,
                         byte[] bytes,
                         boolean addCommunityPermissions,
                         boolean addGuestPermissions)
                         throws java.rmi.RemoteException,
                                com.liferay.portal.PortalException,
                                com.liferay.portal.SystemException
Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException

addFileEntry

DLFileEntry addFileEntry(long folderId,
                         java.lang.String name,
                         java.lang.String title,
                         java.lang.String description,
                         java.lang.String[] tagsEntries,
                         java.lang.String extraSettings,
                         java.io.File file,
                         java.lang.String[] communityPermissions,
                         java.lang.String[] guestPermissions)
                         throws java.rmi.RemoteException,
                                com.liferay.portal.PortalException,
                                com.liferay.portal.SystemException
Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException

addFileEntry

DLFileEntry addFileEntry(long folderId,
                         java.lang.String name,
                         java.lang.String title,
                         java.lang.String description,
                         java.lang.String[] tagsEntries,
                         java.lang.String extraSettings,
                         byte[] bytes,
                         java.lang.String[] communityPermissions,
                         java.lang.String[] guestPermissions)
                         throws java.rmi.RemoteException,
                                com.liferay.portal.PortalException,
                                com.liferay.portal.SystemException
Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException

deleteFileEntry

void deleteFileEntry(long folderId,
                     java.lang.String name)
                     throws com.liferay.portal.PortalException,
                            com.liferay.portal.SystemException,
                            java.rmi.RemoteException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException
java.rmi.RemoteException

deleteFileEntry

void deleteFileEntry(long folderId,
                     java.lang.String name,
                     double version)
                     throws com.liferay.portal.PortalException,
                            com.liferay.portal.SystemException,
                            java.rmi.RemoteException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException
java.rmi.RemoteException

deleteFileEntryByTitle

void deleteFileEntryByTitle(long folderId,
                            java.lang.String titleWithExtension)
                            throws com.liferay.portal.PortalException,
                                   com.liferay.portal.SystemException,
                                   java.rmi.RemoteException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException
java.rmi.RemoteException

getFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DLFileEntry> getFileEntries(long folderId)
                                           throws java.rmi.RemoteException,
                                                  com.liferay.portal.PortalException,
                                                  com.liferay.portal.SystemException
Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getFileEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileEntry getFileEntry(long folderId,
                                       java.lang.String name)
                         throws java.rmi.RemoteException,
                                com.liferay.portal.PortalException,
                                com.liferay.portal.SystemException
Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getFileEntryByTitle

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileEntry getFileEntryByTitle(long folderId,
                                              java.lang.String titleWithExtension)
                                throws java.rmi.RemoteException,
                                       com.liferay.portal.PortalException,
                                       com.liferay.portal.SystemException
Throws:
java.rmi.RemoteException
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getFileEntryLock

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Lock getFileEntryLock(long folderId,
                                    java.lang.String name)
                      throws com.liferay.portal.PortalException,
                             com.liferay.portal.SystemException,
                             java.rmi.RemoteException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException
java.rmi.RemoteException

lockFileEntry

Lock lockFileEntry(long folderId,
                   java.lang.String name)
                   throws com.liferay.portal.PortalException,
                          com.liferay.portal.SystemException,
                          java.rmi.RemoteException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException
java.rmi.RemoteException

lockFileEntry

Lock lockFileEntry(long folderId,
                   java.lang.String name,
                   java.lang.String owner,
                   long expirationTime)
                   throws com.liferay.portal.PortalException,
                          com.liferay.portal.SystemException,
                          java.rmi.RemoteException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException
java.rmi.RemoteException

refreshFileEntryLock

Lock refreshFileEntryLock(java.lang.String lockUuid,
                          long expirationTime)
                          throws com.liferay.portal.PortalException,
                                 com.liferay.portal.SystemException,
                                 java.rmi.RemoteException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException
java.rmi.RemoteException

unlockFileEntry

void unlockFileEntry(long folderId,
                     java.lang.String name)
                     throws com.liferay.portal.SystemException,
                            java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
java.rmi.RemoteException

unlockFileEntry

void unlockFileEntry(long folderId,
                     java.lang.String name,
                     java.lang.String lockUuid)
                     throws com.liferay.portal.PortalException,
                            com.liferay.portal.SystemException,
                            java.rmi.RemoteException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException
java.rmi.RemoteException

updateFileEntry

DLFileEntry updateFileEntry(long folderId,
                            long newFolderId,
                            java.lang.String name,
                            java.lang.String sourceFileName,
                            java.lang.String title,
                            java.lang.String description,
                            java.lang.String[] tagsEntries,
                            java.lang.String extraSettings,
                            byte[] bytes)
                            throws com.liferay.portal.PortalException,
                                   com.liferay.portal.SystemException,
                                   java.rmi.RemoteException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException
java.rmi.RemoteException