@ProviderType
public class DLFileEntryServiceUtil
extends java.lang.Object
com.liferay.portlet.documentlibrary.service.impl.DLFileEntryServiceImpl and is the
primary 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.DLFileEntryService,
com.liferay.portlet.documentlibrary.service.base.DLFileEntryServiceBaseImpl,
com.liferay.portlet.documentlibrary.service.impl.DLFileEntryServiceImpl| Constructor and Description |
|---|
DLFileEntryServiceUtil() |
| Modifier and Type | Method and Description |
|---|---|
static DLFileEntry |
addFileEntry(long groupId,
long repositoryId,
long folderId,
java.lang.String sourceFileName,
java.lang.String mimeType,
java.lang.String title,
java.lang.String description,
java.lang.String changeLog,
long fileEntryTypeId,
java.util.Map<java.lang.String,DDMFormValues> ddmFormValuesMap,
java.io.File file,
java.io.InputStream is,
long size,
ServiceContext serviceContext) |
static DLFileVersion |
cancelCheckOut(long fileEntryId) |
static void |
checkInFileEntry(long fileEntryId,
boolean major,
java.lang.String changeLog,
ServiceContext serviceContext) |
static void |
checkInFileEntry(long fileEntryId,
java.lang.String lockUuid)
Deprecated.
As of 6.2.0, replaced by
checkInFileEntry(long,
String, ServiceContext) |
static void |
checkInFileEntry(long fileEntryId,
java.lang.String lockUuid,
ServiceContext serviceContext) |
static DLFileEntry |
checkOutFileEntry(long fileEntryId)
Deprecated.
As of 6.2.0, replaced by
checkOutFileEntry(long,
ServiceContext) |
static DLFileEntry |
checkOutFileEntry(long fileEntryId,
ServiceContext serviceContext) |
static DLFileEntry |
checkOutFileEntry(long fileEntryId,
java.lang.String owner,
long expirationTime)
Deprecated.
As of 6.2.0, replaced by
checkOutFileEntry(long,
String, long, ServiceContext) |
static DLFileEntry |
checkOutFileEntry(long fileEntryId,
java.lang.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,
java.lang.String title) |
static void |
deleteFileVersion(long fileEntryId,
java.lang.String version) |
static DLFileEntry |
fetchFileEntryByImageId(long imageId) |
static java.io.InputStream |
getFileAsStream(long fileEntryId,
java.lang.String version) |
static java.io.InputStream |
getFileAsStream(long fileEntryId,
java.lang.String version,
boolean incrementCounter) |
static java.util.List<DLFileEntry> |
getFileEntries(long groupId,
long folderId,
int status,
int start,
int end,
OrderByComparator<DLFileEntry> obc) |
static java.util.List<DLFileEntry> |
getFileEntries(long groupId,
long folderId,
int start,
int end,
OrderByComparator<DLFileEntry> obc) |
static java.util.List<DLFileEntry> |
getFileEntries(long groupId,
long folderId,
long fileEntryTypeId,
int start,
int end,
OrderByComparator<DLFileEntry> obc) |
static java.util.List<DLFileEntry> |
getFileEntries(long groupId,
long folderId,
java.lang.String[] mimeTypes,
int start,
int end,
OrderByComparator<DLFileEntry> obc) |
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,
java.lang.String[] mimeTypes) |
static DLFileEntry |
getFileEntry(long fileEntryId) |
static DLFileEntry |
getFileEntry(long groupId,
long folderId,
java.lang.String title) |
static DLFileEntry |
getFileEntryByUuidAndGroupId(java.lang.String uuid,
long groupId) |
static Lock |
getFileEntryLock(long fileEntryId) |
static int |
getFoldersFileEntriesCount(long groupId,
java.util.List<java.lang.Long> folderIds,
int status) |
static java.util.List<DLFileEntry> |
getGroupFileEntries(long groupId,
long userId,
long rootFolderId,
int start,
int end,
OrderByComparator<DLFileEntry> obc) |
static java.util.List<DLFileEntry> |
getGroupFileEntries(long groupId,
long userId,
long repositoryId,
long rootFolderId,
java.lang.String[] mimeTypes,
int status,
int start,
int end,
OrderByComparator<DLFileEntry> obc) |
static java.util.List<DLFileEntry> |
getGroupFileEntries(long groupId,
long userId,
long rootFolderId,
java.lang.String[] mimeTypes,
int status,
int start,
int end,
OrderByComparator<DLFileEntry> obc) |
static int |
getGroupFileEntriesCount(long groupId,
long userId,
long rootFolderId) |
static int |
getGroupFileEntriesCount(long groupId,
long userId,
long repositoryId,
long rootFolderId,
java.lang.String[] mimeTypes,
int status) |
static int |
getGroupFileEntriesCount(long groupId,
long userId,
long rootFolderId,
java.lang.String[] mimeTypes,
int status) |
static java.lang.String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
static DLFileEntryService |
getService() |
static boolean |
hasFileEntryLock(long fileEntryId) |
static boolean |
isFileEntryCheckedOut(long fileEntryId) |
static boolean |
isKeepFileVersionLabel(long fileEntryId,
ServiceContext serviceContext) |
static DLFileEntry |
moveFileEntry(long fileEntryId,
long newFolderId,
ServiceContext serviceContext) |
static Lock |
refreshFileEntryLock(java.lang.String lockUuid,
long companyId,
long expirationTime) |
static void |
revertFileEntry(long fileEntryId,
java.lang.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,
java.lang.String[] mimeTypes,
int status,
int start,
int end) |
static DLFileEntry |
updateFileEntry(long fileEntryId,
java.lang.String sourceFileName,
java.lang.String mimeType,
java.lang.String title,
java.lang.String description,
java.lang.String changeLog,
boolean majorVersion,
long fileEntryTypeId,
java.util.Map<java.lang.String,DDMFormValues> ddmFormValuesMap,
java.io.File file,
java.io.InputStream is,
long size,
ServiceContext serviceContext) |
static DLFileEntry |
updateStatus(long userId,
long fileVersionId,
int status,
ServiceContext serviceContext,
java.util.Map<java.lang.String,java.io.Serializable> workflowContext) |
static boolean |
verifyFileEntryCheckOut(long fileEntryId,
java.lang.String lockUuid) |
static boolean |
verifyFileEntryLock(long fileEntryId,
java.lang.String lockUuid) |
public static DLFileEntry addFileEntry(long groupId, long repositoryId, long folderId, java.lang.String sourceFileName, java.lang.String mimeType, java.lang.String title, java.lang.String description, java.lang.String changeLog, long fileEntryTypeId, java.util.Map<java.lang.String,DDMFormValues> ddmFormValuesMap, java.io.File file, java.io.InputStream is, long size, ServiceContext serviceContext) throws PortalException
PortalExceptionpublic static DLFileVersion cancelCheckOut(long fileEntryId) throws PortalException
PortalException@Deprecated
public static void checkInFileEntry(long fileEntryId,
java.lang.String lockUuid)
throws PortalException
checkInFileEntry(long,
String, ServiceContext)PortalExceptionpublic static void checkInFileEntry(long fileEntryId,
java.lang.String lockUuid,
ServiceContext serviceContext)
throws PortalException
PortalExceptionpublic static void checkInFileEntry(long fileEntryId,
boolean major,
java.lang.String changeLog,
ServiceContext serviceContext)
throws PortalException
PortalException@Deprecated public static DLFileEntry checkOutFileEntry(long fileEntryId) throws PortalException
checkOutFileEntry(long,
ServiceContext)PortalException@Deprecated public static DLFileEntry checkOutFileEntry(long fileEntryId, java.lang.String owner, long expirationTime) throws PortalException
checkOutFileEntry(long,
String, long, ServiceContext)PortalExceptionpublic static DLFileEntry checkOutFileEntry(long fileEntryId, java.lang.String owner, long expirationTime, ServiceContext serviceContext) throws PortalException
PortalExceptionpublic static DLFileEntry checkOutFileEntry(long fileEntryId, ServiceContext serviceContext) throws PortalException
PortalExceptionpublic static DLFileEntry copyFileEntry(long groupId, long repositoryId, long fileEntryId, long destFolderId, ServiceContext serviceContext) throws PortalException
PortalExceptionpublic static void deleteFileEntry(long fileEntryId)
throws PortalException
PortalExceptionpublic static void deleteFileEntry(long groupId,
long folderId,
java.lang.String title)
throws PortalException
PortalExceptionpublic static void deleteFileVersion(long fileEntryId,
java.lang.String version)
throws PortalException
PortalExceptionpublic static DLFileEntry fetchFileEntryByImageId(long imageId) throws PortalException
PortalExceptionpublic static java.io.InputStream getFileAsStream(long fileEntryId,
java.lang.String version)
throws PortalException
PortalExceptionpublic static java.io.InputStream getFileAsStream(long fileEntryId,
java.lang.String version,
boolean incrementCounter)
throws PortalException
PortalExceptionpublic static java.util.List<DLFileEntry> getFileEntries(long groupId, long folderId, long fileEntryTypeId, int start, int end, OrderByComparator<DLFileEntry> obc) throws PortalException
PortalExceptionpublic static java.util.List<DLFileEntry> getFileEntries(long groupId, long folderId, java.lang.String[] mimeTypes, int start, int end, OrderByComparator<DLFileEntry> obc) throws PortalException
PortalExceptionpublic static java.util.List<DLFileEntry> getFileEntries(long groupId, long folderId, int start, int end, OrderByComparator<DLFileEntry> obc) throws PortalException
PortalExceptionpublic static java.util.List<DLFileEntry> getFileEntries(long groupId, long folderId, int status, int start, int end, OrderByComparator<DLFileEntry> obc) throws PortalException
PortalExceptionpublic static int getFileEntriesCount(long groupId,
long folderId)
public static int getFileEntriesCount(long groupId,
long folderId,
long fileEntryTypeId)
public static int getFileEntriesCount(long groupId,
long folderId,
java.lang.String[] mimeTypes)
public static int getFileEntriesCount(long groupId,
long folderId,
int status)
public static DLFileEntry getFileEntry(long fileEntryId) throws PortalException
PortalExceptionpublic static DLFileEntry getFileEntry(long groupId, long folderId, java.lang.String title) throws PortalException
PortalExceptionpublic static DLFileEntry getFileEntryByUuidAndGroupId(java.lang.String uuid, long groupId) throws PortalException
PortalExceptionpublic static Lock getFileEntryLock(long fileEntryId)
public static int getFoldersFileEntriesCount(long groupId,
java.util.List<java.lang.Long> folderIds,
int status)
public static java.util.List<DLFileEntry> getGroupFileEntries(long groupId, long userId, long repositoryId, long rootFolderId, java.lang.String[] mimeTypes, int status, int start, int end, OrderByComparator<DLFileEntry> obc) throws PortalException
PortalExceptionpublic static java.util.List<DLFileEntry> getGroupFileEntries(long groupId, long userId, long rootFolderId, java.lang.String[] mimeTypes, int status, int start, int end, OrderByComparator<DLFileEntry> obc) throws PortalException
PortalExceptionpublic static java.util.List<DLFileEntry> getGroupFileEntries(long groupId, long userId, long rootFolderId, int start, int end, OrderByComparator<DLFileEntry> obc) throws PortalException
PortalExceptionpublic static int getGroupFileEntriesCount(long groupId,
long userId,
long repositoryId,
long rootFolderId,
java.lang.String[] mimeTypes,
int status)
throws PortalException
PortalExceptionpublic static int getGroupFileEntriesCount(long groupId,
long userId,
long rootFolderId)
throws PortalException
PortalExceptionpublic static int getGroupFileEntriesCount(long groupId,
long userId,
long rootFolderId,
java.lang.String[] mimeTypes,
int status)
throws PortalException
PortalExceptionpublic static java.lang.String getOSGiServiceIdentifier()
public static boolean hasFileEntryLock(long fileEntryId)
throws PortalException
PortalExceptionpublic static boolean isFileEntryCheckedOut(long fileEntryId)
throws PortalException
PortalExceptionpublic static boolean isKeepFileVersionLabel(long fileEntryId,
ServiceContext serviceContext)
throws PortalException
PortalExceptionpublic static DLFileEntry moveFileEntry(long fileEntryId, long newFolderId, ServiceContext serviceContext) throws PortalException
PortalExceptionpublic static Lock refreshFileEntryLock(java.lang.String lockUuid, long companyId, long expirationTime) throws PortalException
PortalExceptionpublic static void revertFileEntry(long fileEntryId,
java.lang.String version,
ServiceContext serviceContext)
throws PortalException
PortalExceptionpublic static Hits search(long groupId, long creatorUserId, long folderId, java.lang.String[] mimeTypes, int status, int start, int end) throws PortalException
PortalExceptionpublic static Hits search(long groupId, long creatorUserId, int status, int start, int end) throws PortalException
PortalExceptionpublic static DLFileEntry updateFileEntry(long fileEntryId, java.lang.String sourceFileName, java.lang.String mimeType, java.lang.String title, java.lang.String description, java.lang.String changeLog, boolean majorVersion, long fileEntryTypeId, java.util.Map<java.lang.String,DDMFormValues> ddmFormValuesMap, java.io.File file, java.io.InputStream is, long size, ServiceContext serviceContext) throws PortalException
PortalExceptionpublic static DLFileEntry updateStatus(long userId, long fileVersionId, int status, ServiceContext serviceContext, java.util.Map<java.lang.String,java.io.Serializable> workflowContext) throws PortalException
PortalExceptionpublic static boolean verifyFileEntryCheckOut(long fileEntryId,
java.lang.String lockUuid)
throws PortalException
PortalExceptionpublic static boolean verifyFileEntryLock(long fileEntryId,
java.lang.String lockUuid)
throws PortalException
PortalExceptionpublic static DLFileEntryService getService()