Liferay 7.0-ce-b4

com.liferay.portlet.documentlibrary.service
Interface DLFileEntryService

All Superinterfaces:
BaseService
All Known Implementing Classes:
DLFileEntryServiceBaseImpl, DLFileEntryServiceImpl, DLFileEntryServiceWrapper

@AccessControlled
@JSONWebService
@ProviderType
@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface DLFileEntryService
extends BaseService

Provides the remote service interface for DLFileEntry. 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 it is generated.

Method Summary
 DLFileEntry addFileEntry(long groupId, long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String description, String changeLog, long fileEntryTypeId, Map<String,DDMFormValues> ddmFormValuesMap, File file, InputStream is, long size, ServiceContext serviceContext)
           
 DLFileVersion cancelCheckOut(long fileEntryId)
           
 void checkInFileEntry(long fileEntryId, boolean major, String changeLog, ServiceContext serviceContext)
           
 void checkInFileEntry(long fileEntryId, String lockUuid)
          Deprecated. As of 6.2.0, replaced by checkInFileEntry(long, String, ServiceContext)
 void checkInFileEntry(long fileEntryId, String lockUuid, ServiceContext serviceContext)
           
 DLFileEntry checkOutFileEntry(long fileEntryId)
          Deprecated. As of 6.2.0, replaced by checkOutFileEntry(long, ServiceContext)
 DLFileEntry checkOutFileEntry(long fileEntryId, ServiceContext serviceContext)
           
 DLFileEntry checkOutFileEntry(long fileEntryId, String owner, long expirationTime)
          Deprecated. As of 6.2.0, replaced by checkOutFileEntry(long, String, long, ServiceContext)
 DLFileEntry checkOutFileEntry(long fileEntryId, String owner, long expirationTime, ServiceContext serviceContext)
           
 DLFileEntry copyFileEntry(long groupId, long repositoryId, long fileEntryId, long destFolderId, ServiceContext serviceContext)
           
 void deleteFileEntry(long fileEntryId)
           
 void deleteFileEntry(long groupId, long folderId, String title)
           
 void deleteFileVersion(long fileEntryId, String version)
           
 DLFileEntry fetchFileEntryByImageId(long imageId)
           
 InputStream getFileAsStream(long fileEntryId, String version)
           
 InputStream getFileAsStream(long fileEntryId, String version, boolean incrementCounter)
           
 List<DLFileEntry> getFileEntries(long groupId, long folderId, int status, int start, int end, OrderByComparator<DLFileEntry> obc)
           
 List<DLFileEntry> getFileEntries(long groupId, long folderId, int start, int end, OrderByComparator<DLFileEntry> obc)
           
 List<DLFileEntry> getFileEntries(long groupId, long folderId, long fileEntryTypeId, int start, int end, OrderByComparator<DLFileEntry> obc)
           
 List<DLFileEntry> getFileEntries(long groupId, long folderId, String[] mimeTypes, int start, int end, OrderByComparator<DLFileEntry> obc)
           
 int getFileEntriesCount(long groupId, long folderId)
           
 int getFileEntriesCount(long groupId, long folderId, int status)
           
 int getFileEntriesCount(long groupId, long folderId, long fileEntryTypeId)
           
 int getFileEntriesCount(long groupId, long folderId, String[] mimeTypes)
           
 DLFileEntry getFileEntry(long fileEntryId)
           
 DLFileEntry getFileEntry(long groupId, long folderId, String title)
           
 DLFileEntry getFileEntryByUuidAndGroupId(String uuid, long groupId)
           
 Lock getFileEntryLock(long fileEntryId)
           
 int getFoldersFileEntriesCount(long groupId, List<Long> folderIds, int status)
           
 List<DLFileEntry> getGroupFileEntries(long groupId, long userId, long rootFolderId, int start, int end, OrderByComparator<DLFileEntry> obc)
           
 List<DLFileEntry> getGroupFileEntries(long groupId, long userId, long repositoryId, long rootFolderId, String[] mimeTypes, int status, int start, int end, OrderByComparator<DLFileEntry> obc)
           
 List<DLFileEntry> getGroupFileEntries(long groupId, long userId, long rootFolderId, String[] mimeTypes, int status, int start, int end, OrderByComparator<DLFileEntry> obc)
           
 int getGroupFileEntriesCount(long groupId, long userId, long rootFolderId)
           
 int getGroupFileEntriesCount(long groupId, long userId, long repositoryId, long rootFolderId, String[] mimeTypes, int status)
           
 int getGroupFileEntriesCount(long groupId, long userId, long rootFolderId, String[] mimeTypes, int status)
           
 String getOSGiServiceIdentifier()
          Returns the OSGi service identifier.
 boolean hasFileEntryLock(long fileEntryId)
           
 boolean isFileEntryCheckedOut(long fileEntryId)
           
 boolean isKeepFileVersionLabel(long fileEntryId, ServiceContext serviceContext)
           
 DLFileEntry moveFileEntry(long fileEntryId, long newFolderId, ServiceContext serviceContext)
           
 Lock refreshFileEntryLock(String lockUuid, long companyId, long expirationTime)
           
 void revertFileEntry(long fileEntryId, String version, ServiceContext serviceContext)
           
 Hits search(long groupId, long creatorUserId, int status, int start, int end)
           
 Hits search(long groupId, long creatorUserId, long folderId, String[] mimeTypes, int status, int start, int end)
           
 DLFileEntry updateFileEntry(long fileEntryId, String sourceFileName, String mimeType, String title, String description, String changeLog, boolean majorVersion, long fileEntryTypeId, Map<String,DDMFormValues> ddmFormValuesMap, File file, InputStream is, long size, ServiceContext serviceContext)
           
 DLFileEntry updateStatus(long userId, long fileVersionId, int status, ServiceContext serviceContext, Map<String,Serializable> workflowContext)
           
 boolean verifyFileEntryCheckOut(long fileEntryId, String lockUuid)
           
 boolean verifyFileEntryLock(long fileEntryId, String lockUuid)
           
 

Method Detail

addFileEntry

DLFileEntry addFileEntry(long groupId,
                         long repositoryId,
                         long folderId,
                         String sourceFileName,
                         String mimeType,
                         String title,
                         String description,
                         String changeLog,
                         long fileEntryTypeId,
                         Map<String,DDMFormValues> ddmFormValuesMap,
                         File file,
                         InputStream is,
                         long size,
                         ServiceContext serviceContext)
                         throws PortalException
Throws:
PortalException

cancelCheckOut

DLFileVersion cancelCheckOut(long fileEntryId)
                             throws PortalException
Throws:
PortalException

checkInFileEntry

@Deprecated
void checkInFileEntry(long fileEntryId,
                                 String lockUuid)
                      throws PortalException
Deprecated. As of 6.2.0, replaced by checkInFileEntry(long, String, ServiceContext)

Throws:
PortalException

checkInFileEntry

void checkInFileEntry(long fileEntryId,
                      String lockUuid,
                      ServiceContext serviceContext)
                      throws PortalException
Throws:
PortalException

checkInFileEntry

void checkInFileEntry(long fileEntryId,
                      boolean major,
                      String changeLog,
                      ServiceContext serviceContext)
                      throws PortalException
Throws:
PortalException

checkOutFileEntry

@Deprecated
DLFileEntry checkOutFileEntry(long fileEntryId)
                              throws PortalException
Deprecated. As of 6.2.0, replaced by checkOutFileEntry(long, ServiceContext)

Throws:
PortalException

checkOutFileEntry

@Deprecated
DLFileEntry checkOutFileEntry(long fileEntryId,
                                         String owner,
                                         long expirationTime)
                              throws PortalException
Deprecated. As of 6.2.0, replaced by checkOutFileEntry(long, String, long, ServiceContext)

Throws:
PortalException

checkOutFileEntry

DLFileEntry checkOutFileEntry(long fileEntryId,
                              String owner,
                              long expirationTime,
                              ServiceContext serviceContext)
                              throws PortalException
Throws:
PortalException

checkOutFileEntry

DLFileEntry checkOutFileEntry(long fileEntryId,
                              ServiceContext serviceContext)
                              throws PortalException
Throws:
PortalException

copyFileEntry

DLFileEntry copyFileEntry(long groupId,
                          long repositoryId,
                          long fileEntryId,
                          long destFolderId,
                          ServiceContext serviceContext)
                          throws PortalException
Throws:
PortalException

deleteFileEntry

void deleteFileEntry(long fileEntryId)
                     throws PortalException
Throws:
PortalException

deleteFileEntry

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

deleteFileVersion

void deleteFileVersion(long fileEntryId,
                       String version)
                       throws PortalException
Throws:
PortalException

fetchFileEntryByImageId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileEntry fetchFileEntryByImageId(long imageId)
                                    throws PortalException
Throws:
PortalException

getFileAsStream

InputStream getFileAsStream(long fileEntryId,
                            String version)
                            throws PortalException
Throws:
PortalException

getFileAsStream

InputStream getFileAsStream(long fileEntryId,
                            String version,
                            boolean incrementCounter)
                            throws PortalException
Throws:
PortalException

getFileEntries

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

getFileEntries

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

getFileEntries

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

getFileEntries

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

getFileEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFileEntriesCount(long groupId,
                                                                 long folderId)

getFileEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFileEntriesCount(long groupId,
                                                                 long folderId,
                                                                 long fileEntryTypeId)

getFileEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFileEntriesCount(long groupId,
                                                                 long folderId,
                                                                 String[] mimeTypes)

getFileEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFileEntriesCount(long groupId,
                                                                 long folderId,
                                                                 int status)

getFileEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileEntry getFileEntry(long fileEntryId)
                         throws PortalException
Throws:
PortalException

getFileEntry

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

getFileEntryByUuidAndGroupId

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

getFileEntryLock

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Lock getFileEntryLock(long fileEntryId)

getFoldersFileEntriesCount

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

getGroupFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getGroupFileEntries(long groupId,
                                                                               long userId,
                                                                               long repositoryId,
                                                                               long rootFolderId,
                                                                               String[] mimeTypes,
                                                                               int status,
                                                                               int start,
                                                                               int end,
                                                                               OrderByComparator<DLFileEntry> obc)
                                      throws PortalException
Throws:
PortalException

getGroupFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getGroupFileEntries(long groupId,
                                                                               long userId,
                                                                               long rootFolderId,
                                                                               String[] mimeTypes,
                                                                               int status,
                                                                               int start,
                                                                               int end,
                                                                               OrderByComparator<DLFileEntry> obc)
                                      throws PortalException
Throws:
PortalException

getGroupFileEntries

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

getGroupFileEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getGroupFileEntriesCount(long groupId,
                                                                      long userId,
                                                                      long repositoryId,
                                                                      long rootFolderId,
                                                                      String[] mimeTypes,
                                                                      int status)
                             throws PortalException
Throws:
PortalException

getGroupFileEntriesCount

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

getGroupFileEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getGroupFileEntriesCount(long groupId,
                                                                      long userId,
                                                                      long rootFolderId,
                                                                      String[] mimeTypes,
                                                                      int status)
                             throws PortalException
Throws:
PortalException

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()
Returns the OSGi service identifier.

Returns:
the OSGi service identifier

hasFileEntryLock

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasFileEntryLock(long fileEntryId)
                         throws PortalException
Throws:
PortalException

isFileEntryCheckedOut

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean isFileEntryCheckedOut(long fileEntryId)
                              throws PortalException
Throws:
PortalException

isKeepFileVersionLabel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean isKeepFileVersionLabel(long fileEntryId,
                                                                        ServiceContext serviceContext)
                               throws PortalException
Throws:
PortalException

moveFileEntry

DLFileEntry moveFileEntry(long fileEntryId,
                          long newFolderId,
                          ServiceContext serviceContext)
                          throws PortalException
Throws:
PortalException

refreshFileEntryLock

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

revertFileEntry

void revertFileEntry(long fileEntryId,
                     String version,
                     ServiceContext serviceContext)
                     throws PortalException
Throws:
PortalException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Hits search(long groupId,
                                                     long creatorUserId,
                                                     long folderId,
                                                     String[] mimeTypes,
                                                     int status,
                                                     int start,
                                                     int end)
            throws PortalException
Throws:
PortalException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Hits search(long groupId,
                                                     long creatorUserId,
                                                     int status,
                                                     int start,
                                                     int end)
            throws PortalException
Throws:
PortalException

updateFileEntry

DLFileEntry updateFileEntry(long fileEntryId,
                            String sourceFileName,
                            String mimeType,
                            String title,
                            String description,
                            String changeLog,
                            boolean majorVersion,
                            long fileEntryTypeId,
                            Map<String,DDMFormValues> ddmFormValuesMap,
                            File file,
                            InputStream is,
                            long size,
                            ServiceContext serviceContext)
                            throws PortalException
Throws:
PortalException

updateStatus

DLFileEntry updateStatus(long userId,
                         long fileVersionId,
                         int status,
                         ServiceContext serviceContext,
                         Map<String,Serializable> workflowContext)
                         throws PortalException
Throws:
PortalException

verifyFileEntryCheckOut

boolean verifyFileEntryCheckOut(long fileEntryId,
                                String lockUuid)
                                throws PortalException
Throws:
PortalException

verifyFileEntryLock

boolean verifyFileEntryLock(long fileEntryId,
                            String lockUuid)
                            throws PortalException
Throws:
PortalException

Liferay 7.0-ce-b4