Liferay 6.0.5

com.liferay.portlet.documentlibrary.service
Interface DLFileEntryService

All Known Implementing Classes:
DLFileEntryServiceBaseImpl, DLFileEntryServiceImpl, DLFileEntryServiceWrapper

@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface DLFileEntryService

The interface for the d l file entry remote service.

Never modify or reference this interface directly. Always use DLFileEntryServiceUtil to access the d l file entry remote service. Add custom service methods to DLFileEntryServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

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.

See Also:
DLFileEntryServiceUtil, DLFileEntryServiceBaseImpl, DLFileEntryServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary
 DLFileEntry addFileEntry(long groupId, long folderId, String name, String title, String description, String changeLog, String extraSettings, byte[] bytes, ServiceContext serviceContext)
           
 DLFileEntry addFileEntry(long groupId, long folderId, String name, String title, String description, String changeLog, String extraSettings, File file, ServiceContext serviceContext)
           
 void deleteFileEntry(long groupId, long folderId, String name)
           
 void deleteFileEntry(long groupId, long folderId, String name, String version)
           
 void deleteFileEntryByTitle(long groupId, long folderId, String titleWithExtension)
           
 List<DLFileEntry> getFileEntries(long groupId, long folderId)
           
 List<DLFileEntry> getFileEntries(long groupId, long folderId, int start, int end)
           
 List<DLFileEntry> getFileEntries(long groupId, long folderId, int start, int end, OrderByComparator obc)
           
 int getFileEntriesCount(long groupId, long folderId)
           
 DLFileEntry getFileEntry(long groupId, long folderId, String name)
           
 DLFileEntry getFileEntryByTitle(long groupId, long folderId, String titleWithExtension)
           
 DLFileEntry getFileEntryByUuidAndGroupId(String uuid, long groupId)
           
 int getFoldersFileEntriesCount(long groupId, List<Long> folderIds, int status)
           
 List<DLFileEntry> getGroupFileEntries(long groupId, long userId, int start, int end)
           
 List<DLFileEntry> getGroupFileEntries(long groupId, long userId, int start, int end, OrderByComparator obc)
           
 int getGroupFileEntriesCount(long groupId, long userId)
           
 boolean hasFileEntryLock(long groupId, long folderId, String name)
           
 Lock lockFileEntry(long groupId, long folderId, String name)
           
 Lock lockFileEntry(long groupId, long folderId, String name, String owner, long expirationTime)
           
 DLFileEntry moveFileEntry(long groupId, long folderId, long newFolderId, String name, ServiceContext serviceContext)
           
 Lock refreshFileEntryLock(String lockUuid, long expirationTime)
           
 void unlockFileEntry(long groupId, long folderId, String name)
           
 void unlockFileEntry(long groupId, long folderId, String name, String lockUuid)
           
 DLFileEntry updateFileEntry(long groupId, long folderId, String name, String sourceFileName, String title, String description, String changeLog, boolean majorVersion, String extraSettings, byte[] bytes, ServiceContext serviceContext)
           
 DLFileEntry updateFileEntry(long groupId, long folderId, String name, String sourceFileName, String title, String description, String changeLog, boolean majorVersion, String extraSettings, File file, ServiceContext serviceContext)
           
 boolean verifyFileEntryLock(long groupId, long folderId, String name, String lockUuid)
           
 

Method Detail

addFileEntry

DLFileEntry addFileEntry(long groupId,
                         long folderId,
                         String name,
                         String title,
                         String description,
                         String changeLog,
                         String extraSettings,
                         byte[] bytes,
                         ServiceContext serviceContext)
                         throws PortalException,
                                SystemException
Throws:
PortalException
SystemException

addFileEntry

DLFileEntry addFileEntry(long groupId,
                         long folderId,
                         String name,
                         String title,
                         String description,
                         String changeLog,
                         String extraSettings,
                         File file,
                         ServiceContext serviceContext)
                         throws PortalException,
                                SystemException
Throws:
PortalException
SystemException

deleteFileEntry

void deleteFileEntry(long groupId,
                     long folderId,
                     String name)
                     throws PortalException,
                            SystemException
Throws:
PortalException
SystemException

deleteFileEntry

void deleteFileEntry(long groupId,
                     long folderId,
                     String name,
                     String version)
                     throws PortalException,
                            SystemException
Throws:
PortalException
SystemException

deleteFileEntryByTitle

void deleteFileEntryByTitle(long groupId,
                            long folderId,
                            String titleWithExtension)
                            throws PortalException,
                                   SystemException
Throws:
PortalException
SystemException

getFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getFileEntries(long groupId,
                                                                          long folderId)
                                 throws PortalException,
                                        SystemException
Throws:
PortalException
SystemException

getFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getFileEntries(long groupId,
                                                                          long folderId,
                                                                          int start,
                                                                          int end)
                                 throws PortalException,
                                        SystemException
Throws:
PortalException
SystemException

getFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getFileEntries(long groupId,
                                                                          long folderId,
                                                                          int start,
                                                                          int end,
                                                                          OrderByComparator obc)
                                 throws PortalException,
                                        SystemException
Throws:
PortalException
SystemException

getFileEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFileEntriesCount(long groupId,
                                                                 long folderId)
                        throws PortalException,
                               SystemException
Throws:
PortalException
SystemException

getFileEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileEntry getFileEntry(long groupId,
                                                                  long folderId,
                                                                  String name)
                         throws PortalException,
                                SystemException
Throws:
PortalException
SystemException

getFileEntryByTitle

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileEntry getFileEntryByTitle(long groupId,
                                                                         long folderId,
                                                                         String titleWithExtension)
                                throws PortalException,
                                       SystemException
Throws:
PortalException
SystemException

getFileEntryByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileEntry getFileEntryByUuidAndGroupId(String uuid,
                                                                                  long groupId)
                                         throws PortalException,
                                                SystemException
Throws:
PortalException
SystemException

getFoldersFileEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFoldersFileEntriesCount(long groupId,
                                                                        List<Long> folderIds,
                                                                        int status)
                               throws SystemException
Throws:
SystemException

getGroupFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getGroupFileEntries(long groupId,
                                                                               long userId,
                                                                               int start,
                                                                               int end)
                                      throws SystemException
Throws:
SystemException

getGroupFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getGroupFileEntries(long groupId,
                                                                               long userId,
                                                                               int start,
                                                                               int end,
                                                                               OrderByComparator obc)
                                      throws SystemException
Throws:
SystemException

getGroupFileEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getGroupFileEntriesCount(long groupId,
                                                                      long userId)
                             throws SystemException
Throws:
SystemException

hasFileEntryLock

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasFileEntryLock(long groupId,
                                                                  long folderId,
                                                                  String name)
                         throws PortalException,
                                SystemException
Throws:
PortalException
SystemException

lockFileEntry

Lock lockFileEntry(long groupId,
                   long folderId,
                   String name)
                   throws PortalException,
                          SystemException
Throws:
PortalException
SystemException

lockFileEntry

Lock lockFileEntry(long groupId,
                   long folderId,
                   String name,
                   String owner,
                   long expirationTime)
                   throws PortalException,
                          SystemException
Throws:
PortalException
SystemException

moveFileEntry

DLFileEntry moveFileEntry(long groupId,
                          long folderId,
                          long newFolderId,
                          String name,
                          ServiceContext serviceContext)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

refreshFileEntryLock

Lock refreshFileEntryLock(String lockUuid,
                          long expirationTime)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

unlockFileEntry

void unlockFileEntry(long groupId,
                     long folderId,
                     String name)
                     throws SystemException
Throws:
SystemException

unlockFileEntry

void unlockFileEntry(long groupId,
                     long folderId,
                     String name,
                     String lockUuid)
                     throws PortalException,
                            SystemException
Throws:
PortalException
SystemException

updateFileEntry

DLFileEntry updateFileEntry(long groupId,
                            long folderId,
                            String name,
                            String sourceFileName,
                            String title,
                            String description,
                            String changeLog,
                            boolean majorVersion,
                            String extraSettings,
                            byte[] bytes,
                            ServiceContext serviceContext)
                            throws PortalException,
                                   SystemException
Throws:
PortalException
SystemException

updateFileEntry

DLFileEntry updateFileEntry(long groupId,
                            long folderId,
                            String name,
                            String sourceFileName,
                            String title,
                            String description,
                            String changeLog,
                            boolean majorVersion,
                            String extraSettings,
                            File file,
                            ServiceContext serviceContext)
                            throws PortalException,
                                   SystemException
Throws:
PortalException
SystemException

verifyFileEntryLock

boolean verifyFileEntryLock(long groupId,
                            long folderId,
                            String name,
                            String lockUuid)
                            throws PortalException,
                                   SystemException
Throws:
PortalException
SystemException

Liferay 6.0.5