com.liferay.document.library.kernel.service

Class DLFileEntryServiceUtil

Object

com.liferay.document.library.kernel.service.DLFileEntryServiceUtil

public class DLFileEntryServiceUtil
extends Object

Provides the remote service utility for DLFileEntry. This utility wraps com.liferay.portlet.documentlibrary.service.impl.DLFileEntryServiceImpl and is an access point for service operations in application layer code running on a remote server. 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:

DLFileEntryService

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
DLFileEntryServiceUtil()

Method Summary

Modifier and Type	Method and Description
static DLFileEntry	addFileEntry(String externalReferenceCode, long groupId, long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, long fileEntryTypeId, Map<String,DDMFormValues> ddmFormValuesMap, File file, InputStream inputStream, long size, Date expirationDate, Date reviewDate, ServiceContext serviceContext)
static DLFileVersion	cancelCheckOut(long fileEntryId)
static void	checkInFileEntry(long fileEntryId, DLVersionNumberIncrease dlVersionNumberIncrease, String changeLog, ServiceContext serviceContext)
static void	checkInFileEntry(long fileEntryId, String lockUuid, ServiceContext serviceContext)
static DLFileEntry	checkOutFileEntry(long fileEntryId, ServiceContext serviceContext)
static DLFileEntry	checkOutFileEntry(long fileEntryId, String owner, long expirationTime, ServiceContext serviceContext)
static DLFileEntry	copyFileEntry(long groupId, long repositoryId, long fileEntryId, long destFolderId, ServiceContext serviceContext)
static void	deleteFileEntry(long fileEntryId)
static void	deleteFileEntry(long groupId, long folderId, String title)
static void	deleteFileVersion(long fileEntryId, String version)
static DLFileEntry	fetchFileEntryByExternalReferenceCode(long groupId, String externalReferenceCode)
static DLFileEntry	fetchFileEntryByImageId(long imageId)
static InputStream	getFileAsStream(long fileEntryId, String version)
static InputStream	getFileAsStream(long fileEntryId, String version, boolean incrementCounter)
static List<DLFileEntry>	getFileEntries(long groupId, long folderId, int status, int start, int end, OrderByComparator<DLFileEntry> orderByComparator)
static List<DLFileEntry>	getFileEntries(long groupId, long folderId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator)
static List<DLFileEntry>	getFileEntries(long groupId, long folderId, long fileEntryTypeId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator)
static List<DLFileEntry>	getFileEntries(long groupId, long folderId, String[] mimeTypes, int status, int start, int end, OrderByComparator<DLFileEntry> orderByComparator)
static List<DLFileEntry>	getFileEntries(long groupId, long folderId, String[] mimeTypes, int start, int end, OrderByComparator<DLFileEntry> orderByComparator)
static int	getFileEntriesCount(long groupId, long folderId)
static int	getFileEntriesCount(long groupId, long folderId, int status)
static int	getFileEntriesCount(long groupId, long folderId, long fileEntryTypeId)
static int	getFileEntriesCount(long groupId, long folderId, String[] mimeTypes)
static int	getFileEntriesCount(long groupId, long folderId, String[] mimeTypes, int status)
static DLFileEntry	getFileEntry(long fileEntryId)
static DLFileEntry	getFileEntry(long groupId, long folderId, String title)
static DLFileEntry	getFileEntryByExternalReferenceCode(long groupId, String externalReferenceCode)
static DLFileEntry	getFileEntryByFileName(long groupId, long folderId, String fileName)
static DLFileEntry	getFileEntryByUuidAndGroupId(String uuid, long groupId)
static Lock	getFileEntryLock(long fileEntryId)
static int	getFoldersFileEntriesCount(long groupId, List<Long> folderIds, int status)
static List<DLFileEntry>	getGroupFileEntries(long groupId, long userId, long rootFolderId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator)
static List<DLFileEntry>	getGroupFileEntries(long groupId, long userId, long repositoryId, long rootFolderId, String[] mimeTypes, int status, int start, int end, OrderByComparator<DLFileEntry> orderByComparator)
static List<DLFileEntry>	getGroupFileEntries(long groupId, long userId, long rootFolderId, String[] mimeTypes, int status, int start, int end, OrderByComparator<DLFileEntry> orderByComparator)
static int	getGroupFileEntriesCount(long groupId, long userId, long rootFolderId)
static int	getGroupFileEntriesCount(long groupId, long userId, long repositoryId, long rootFolderId, String[] mimeTypes, int status)
static int	getGroupFileEntriesCount(long groupId, long userId, long rootFolderId, String[] mimeTypes, int status)
static String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static DLFileEntryService	getService()
static boolean	hasFileEntryLock(long fileEntryId)
static boolean	isFileEntryCheckedOut(long fileEntryId)
static DLFileEntry	moveFileEntry(long fileEntryId, long newFolderId, ServiceContext serviceContext)
static Lock	refreshFileEntryLock(String lockUuid, long companyId, long expirationTime)
static void	revertFileEntry(long fileEntryId, String version, ServiceContext serviceContext)
static Hits	search(long groupId, long creatorUserId, int status, int start, int end)
static Hits	search(long groupId, long creatorUserId, long folderId, String[] mimeTypes, int status, int start, int end)
static DLFileEntry	updateFileEntry(long fileEntryId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, long fileEntryTypeId, Map<String,DDMFormValues> ddmFormValuesMap, File file, InputStream inputStream, long size, Date expirationDate, Date reviewDate, ServiceContext serviceContext)
static DLFileEntry	updateStatus(long userId, long fileVersionId, int status, ServiceContext serviceContext, Map<String,Serializable> workflowContext)
static boolean	verifyFileEntryCheckOut(long fileEntryId, String lockUuid)
static boolean	verifyFileEntryLock(long fileEntryId, String lockUuid)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DLFileEntryServiceUtil

public DLFileEntryServiceUtil()

Method Detail

addFileEntry

public static DLFileEntry addFileEntry(String externalReferenceCode,
                                       long groupId,
                                       long repositoryId,
                                       long folderId,
                                       String sourceFileName,
                                       String mimeType,
                                       String title,
                                       String urlTitle,
                                       String description,
                                       String changeLog,
                                       long fileEntryTypeId,
                                       Map<String,DDMFormValues> ddmFormValuesMap,
                                       File file,
                                       InputStream inputStream,
                                       long size,
                                       Date expirationDate,
                                       Date reviewDate,
                                       ServiceContext serviceContext)
                                throws PortalException

Throws:

PortalException

cancelCheckOut

public static DLFileVersion cancelCheckOut(long fileEntryId)
                                    throws PortalException

Throws:

PortalException

checkInFileEntry

public static void checkInFileEntry(long fileEntryId,
                                    DLVersionNumberIncrease dlVersionNumberIncrease,
                                    String changeLog,
                                    ServiceContext serviceContext)
                             throws PortalException

Throws:

PortalException

checkInFileEntry

public static void checkInFileEntry(long fileEntryId,
                                    String lockUuid,
                                    ServiceContext serviceContext)
                             throws PortalException

Throws:

PortalException

checkOutFileEntry

public static DLFileEntry checkOutFileEntry(long fileEntryId,
                                            ServiceContext serviceContext)
                                     throws PortalException

Throws:

PortalException

checkOutFileEntry

public static DLFileEntry checkOutFileEntry(long fileEntryId,
                                            String owner,
                                            long expirationTime,
                                            ServiceContext serviceContext)
                                     throws PortalException

Throws:

PortalException

copyFileEntry

public static DLFileEntry copyFileEntry(long groupId,
                                        long repositoryId,
                                        long fileEntryId,
                                        long destFolderId,
                                        ServiceContext serviceContext)
                                 throws PortalException

Throws:

PortalException

deleteFileEntry

public static void deleteFileEntry(long fileEntryId)
                            throws PortalException

Throws:

PortalException

deleteFileEntry

public static void deleteFileEntry(long groupId,
                                   long folderId,
                                   String title)
                            throws PortalException

Throws:

PortalException

deleteFileVersion

public static void deleteFileVersion(long fileEntryId,
                                     String version)
                              throws PortalException

Throws:

PortalException

fetchFileEntryByExternalReferenceCode

public static DLFileEntry fetchFileEntryByExternalReferenceCode(long groupId,
                                                                String externalReferenceCode)
                                                         throws PortalException

Throws:

PortalException

fetchFileEntryByImageId

public static DLFileEntry fetchFileEntryByImageId(long imageId)
                                           throws PortalException

Throws:

PortalException

getFileAsStream

public static InputStream getFileAsStream(long fileEntryId,
                                          String version)
                                   throws PortalException

Throws:

PortalException

getFileAsStream

public static InputStream getFileAsStream(long fileEntryId,
                                          String version,
                                          boolean incrementCounter)
                                   throws PortalException

Throws:

PortalException

getFileEntries

public static List<DLFileEntry> getFileEntries(long groupId,
                                               long folderId,
                                               int status,
                                               int start,
                                               int end,
                                               OrderByComparator<DLFileEntry> orderByComparator)
                                        throws PortalException

Throws:

PortalException

getFileEntries

public static List<DLFileEntry> getFileEntries(long groupId,
                                               long folderId,
                                               int start,
                                               int end,
                                               OrderByComparator<DLFileEntry> orderByComparator)
                                        throws PortalException

Throws:

PortalException

getFileEntries

public static List<DLFileEntry> getFileEntries(long groupId,
                                               long folderId,
                                               long fileEntryTypeId,
                                               int start,
                                               int end,
                                               OrderByComparator<DLFileEntry> orderByComparator)
                                        throws PortalException

Throws:

PortalException

getFileEntries

public static List<DLFileEntry> getFileEntries(long groupId,
                                               long folderId,
                                               String[] mimeTypes,
                                               int status,
                                               int start,
                                               int end,
                                               OrderByComparator<DLFileEntry> orderByComparator)
                                        throws PortalException

Throws:

PortalException

getFileEntries

public static List<DLFileEntry> getFileEntries(long groupId,
                                               long folderId,
                                               String[] mimeTypes,
                                               int start,
                                               int end,
                                               OrderByComparator<DLFileEntry> orderByComparator)
                                        throws PortalException

Throws:

PortalException

getFileEntriesCount

public static int getFileEntriesCount(long groupId,
                                      long folderId)

getFileEntriesCount

public static int getFileEntriesCount(long groupId,
                                      long folderId,
                                      int status)

getFileEntriesCount

public static int getFileEntriesCount(long groupId,
                                      long folderId,
                                      long fileEntryTypeId)

getFileEntriesCount

public static int getFileEntriesCount(long groupId,
                                      long folderId,
                                      String[] mimeTypes)

getFileEntriesCount

public static int getFileEntriesCount(long groupId,
                                      long folderId,
                                      String[] mimeTypes,
                                      int status)

getFileEntry

public static DLFileEntry getFileEntry(long fileEntryId)
                                throws PortalException

Throws:

PortalException

getFileEntry

public static DLFileEntry getFileEntry(long groupId,
                                       long folderId,
                                       String title)
                                throws PortalException

Throws:

PortalException

getFileEntryByExternalReferenceCode

public static DLFileEntry getFileEntryByExternalReferenceCode(long groupId,
                                                              String externalReferenceCode)
                                                       throws PortalException

Throws:

PortalException

getFileEntryByFileName

public static DLFileEntry getFileEntryByFileName(long groupId,
                                                 long folderId,
                                                 String fileName)
                                          throws PortalException

Throws:

PortalException

getFileEntryByUuidAndGroupId

public static DLFileEntry getFileEntryByUuidAndGroupId(String uuid,
                                                       long groupId)
                                                throws PortalException

Throws:

PortalException

getFileEntryLock

public static Lock getFileEntryLock(long fileEntryId)

getFoldersFileEntriesCount

public static int getFoldersFileEntriesCount(long groupId,
                                             List<Long> folderIds,
                                             int status)

getGroupFileEntries

public static List<DLFileEntry> getGroupFileEntries(long groupId,
                                                    long userId,
                                                    long rootFolderId,
                                                    int start,
                                                    int end,
                                                    OrderByComparator<DLFileEntry> orderByComparator)
                                             throws PortalException

Throws:

PortalException

getGroupFileEntries

public static List<DLFileEntry> getGroupFileEntries(long groupId,
                                                    long userId,
                                                    long repositoryId,
                                                    long rootFolderId,
                                                    String[] mimeTypes,
                                                    int status,
                                                    int start,
                                                    int end,
                                                    OrderByComparator<DLFileEntry> orderByComparator)
                                             throws PortalException

Throws:

PortalException

getGroupFileEntries

public static List<DLFileEntry> getGroupFileEntries(long groupId,
                                                    long userId,
                                                    long rootFolderId,
                                                    String[] mimeTypes,
                                                    int status,
                                                    int start,
                                                    int end,
                                                    OrderByComparator<DLFileEntry> orderByComparator)
                                             throws PortalException

Throws:

PortalException

getGroupFileEntriesCount

public static int getGroupFileEntriesCount(long groupId,
                                           long userId,
                                           long rootFolderId)
                                    throws PortalException

Throws:

PortalException

getGroupFileEntriesCount

public static int getGroupFileEntriesCount(long groupId,
                                           long userId,
                                           long repositoryId,
                                           long rootFolderId,
                                           String[] mimeTypes,
                                           int status)
                                    throws PortalException

Throws:

PortalException

getGroupFileEntriesCount

public static int getGroupFileEntriesCount(long groupId,
                                           long userId,
                                           long rootFolderId,
                                           String[] mimeTypes,
                                           int status)
                                    throws PortalException

Throws:

PortalException

getOSGiServiceIdentifier

public static String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

hasFileEntryLock

public static boolean hasFileEntryLock(long fileEntryId)
                                throws PortalException

Throws:

PortalException

isFileEntryCheckedOut

public static boolean isFileEntryCheckedOut(long fileEntryId)
                                     throws PortalException

Throws:

PortalException

moveFileEntry

public static DLFileEntry moveFileEntry(long fileEntryId,
                                        long newFolderId,
                                        ServiceContext serviceContext)
                                 throws PortalException

Throws:

PortalException

refreshFileEntryLock

public static Lock refreshFileEntryLock(String lockUuid,
                                        long companyId,
                                        long expirationTime)
                                 throws PortalException

Throws:

PortalException

revertFileEntry

public static void revertFileEntry(long fileEntryId,
                                   String version,
                                   ServiceContext serviceContext)
                            throws PortalException

Throws:

PortalException

search

public static Hits search(long groupId,
                          long creatorUserId,
                          int status,
                          int start,
                          int end)
                   throws PortalException

Throws:

PortalException

search

public static Hits search(long groupId,
                          long creatorUserId,
                          long folderId,
                          String[] mimeTypes,
                          int status,
                          int start,
                          int end)
                   throws PortalException

Throws:

PortalException

updateFileEntry

public static DLFileEntry updateFileEntry(long fileEntryId,
                                          String sourceFileName,
                                          String mimeType,
                                          String title,
                                          String urlTitle,
                                          String description,
                                          String changeLog,
                                          DLVersionNumberIncrease dlVersionNumberIncrease,
                                          long fileEntryTypeId,
                                          Map<String,DDMFormValues> ddmFormValuesMap,
                                          File file,
                                          InputStream inputStream,
                                          long size,
                                          Date expirationDate,
                                          Date reviewDate,
                                          ServiceContext serviceContext)
                                   throws PortalException

Throws:

PortalException

updateStatus

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

Throws:

PortalException

verifyFileEntryCheckOut

public static boolean verifyFileEntryCheckOut(long fileEntryId,
                                              String lockUuid)
                                       throws PortalException

Throws:

PortalException

verifyFileEntryLock

public static boolean verifyFileEntryLock(long fileEntryId,
                                          String lockUuid)
                                   throws PortalException

Throws:

PortalException

getService

public static DLFileEntryService getService()