com.liferay.portlet.documentlibrary.service
Class DLFileEntryServiceUtil
java.lang.Object
com.liferay.portlet.documentlibrary.service.DLFileEntryServiceUtil
public class DLFileEntryServiceUtil
- extends Object
The utility for the document library file entry remote service. This utility wraps 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.
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:
DLFileEntryService
,
com.liferay.portlet.documentlibrary.service.base.DLFileEntryServiceBaseImpl
,
com.liferay.portlet.documentlibrary.service.impl.DLFileEntryServiceImpl
Method Summary |
static DLFileEntry |
addFileEntry(long groupId,
long repositoryId,
long folderId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
long fileEntryTypeId,
Map<String,Fields> fieldsMap,
File file,
InputStream is,
long size,
ServiceContext serviceContext)
|
static void |
cancelCheckOut(long fileEntryId)
|
static void |
checkInFileEntry(long fileEntryId,
boolean major,
String changeLog,
ServiceContext serviceContext)
|
static void |
checkInFileEntry(long fileEntryId,
String lockUuid)
|
static DLFileEntry |
checkOutFileEntry(long fileEntryId)
Deprecated. checkOutFileEntry(long, ServiceContext) |
static DLFileEntry |
checkOutFileEntry(long fileEntryId,
ServiceContext serviceContext)
|
static DLFileEntry |
checkOutFileEntry(long fileEntryId,
String owner,
long expirationTime)
Deprecated. checkOutFileEntry(long, String, long,
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 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 start,
int end,
OrderByComparator obc)
|
static List<DLFileEntry> |
getFileEntries(long groupId,
long folderId,
long fileEntryTypeId,
int start,
int end,
OrderByComparator obc)
|
static List<DLFileEntry> |
getFileEntries(long groupId,
long folderId,
String[] mimeTypes,
int start,
int end,
OrderByComparator obc)
|
static int |
getFileEntriesCount(long groupId,
long folderId)
|
static int |
getFileEntriesCount(long groupId,
long folderId,
long fileEntryTypeId)
|
static int |
getFileEntriesCount(long groupId,
long folderId,
String[] mimeTypes)
|
static DLFileEntry |
getFileEntry(long fileEntryId)
|
static DLFileEntry |
getFileEntry(long groupId,
long folderId,
String title)
|
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 obc)
|
static List<DLFileEntry> |
getGroupFileEntries(long groupId,
long userId,
long rootFolderId,
String[] mimeTypes,
int status,
int start,
int end,
OrderByComparator obc)
|
static int |
getGroupFileEntriesCount(long groupId,
long userId,
long rootFolderId)
|
static int |
getGroupFileEntriesCount(long groupId,
long userId,
long rootFolderId,
String[] mimeTypes,
int status)
|
static DLFileEntryService |
getService()
|
static boolean |
hasFileEntryLock(long fileEntryId)
|
static boolean |
isFileEntryCheckedOut(long fileEntryId)
|
static Lock |
lockFileEntry(long fileEntryId)
|
static Lock |
lockFileEntry(long fileEntryId,
String owner,
long expirationTime)
|
static DLFileEntry |
moveFileEntry(long fileEntryId,
long newFolderId,
ServiceContext serviceContext)
|
static Lock |
refreshFileEntryLock(String lockUuid,
long expirationTime)
|
static void |
revertFileEntry(long fileEntryId,
String version,
ServiceContext serviceContext)
|
void |
setService(DLFileEntryService service)
|
static void |
unlockFileEntry(long fileEntryId)
|
static void |
unlockFileEntry(long fileEntryId,
String lockUuid)
|
static DLFileEntry |
updateFileEntry(long fileEntryId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
boolean majorVersion,
long fileEntryTypeId,
Map<String,Fields> fieldsMap,
File file,
InputStream is,
long size,
ServiceContext serviceContext)
|
static boolean |
verifyFileEntryCheckOut(long fileEntryId,
String lockUuid)
|
static boolean |
verifyFileEntryLock(long fileEntryId,
String lockUuid)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
DLFileEntryServiceUtil
public DLFileEntryServiceUtil()
addFileEntry
public static DLFileEntry addFileEntry(long groupId,
long repositoryId,
long folderId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
long fileEntryTypeId,
Map<String,Fields> fieldsMap,
File file,
InputStream is,
long size,
ServiceContext serviceContext)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
cancelCheckOut
public static void cancelCheckOut(long fileEntryId)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
checkInFileEntry
public static void checkInFileEntry(long fileEntryId,
boolean major,
String changeLog,
ServiceContext serviceContext)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
checkInFileEntry
public static void checkInFileEntry(long fileEntryId,
String lockUuid)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
checkOutFileEntry
public static DLFileEntry checkOutFileEntry(long fileEntryId)
throws PortalException,
SystemException
- Deprecated.
checkOutFileEntry(long, ServiceContext)
- Throws:
PortalException
SystemException
checkOutFileEntry
public static DLFileEntry checkOutFileEntry(long fileEntryId,
ServiceContext serviceContext)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
checkOutFileEntry
public static DLFileEntry checkOutFileEntry(long fileEntryId,
String owner,
long expirationTime)
throws PortalException,
SystemException
- Deprecated.
checkOutFileEntry(long, String, long,
ServiceContext)
- Throws:
PortalException
SystemException
checkOutFileEntry
public static DLFileEntry checkOutFileEntry(long fileEntryId,
String owner,
long expirationTime,
ServiceContext serviceContext)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
copyFileEntry
public static DLFileEntry copyFileEntry(long groupId,
long repositoryId,
long fileEntryId,
long destFolderId,
ServiceContext serviceContext)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
deleteFileEntry
public static void deleteFileEntry(long fileEntryId)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
deleteFileEntry
public static void deleteFileEntry(long groupId,
long folderId,
String title)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
fetchFileEntryByImageId
public static DLFileEntry fetchFileEntryByImageId(long imageId)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
getFileAsStream
public static InputStream getFileAsStream(long fileEntryId,
String version)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
getFileAsStream
public static InputStream getFileAsStream(long fileEntryId,
String version,
boolean incrementCounter)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
getFileEntries
public static List<DLFileEntry> getFileEntries(long groupId,
long folderId,
int start,
int end,
OrderByComparator obc)
throws SystemException
- Throws:
SystemException
getFileEntries
public static List<DLFileEntry> getFileEntries(long groupId,
long folderId,
long fileEntryTypeId,
int start,
int end,
OrderByComparator obc)
throws SystemException
- Throws:
SystemException
getFileEntries
public static List<DLFileEntry> getFileEntries(long groupId,
long folderId,
String[] mimeTypes,
int start,
int end,
OrderByComparator obc)
throws SystemException
- Throws:
SystemException
getFileEntriesCount
public static int getFileEntriesCount(long groupId,
long folderId)
throws SystemException
- Throws:
SystemException
getFileEntriesCount
public static int getFileEntriesCount(long groupId,
long folderId,
long fileEntryTypeId)
throws SystemException
- Throws:
SystemException
getFileEntriesCount
public static int getFileEntriesCount(long groupId,
long folderId,
String[] mimeTypes)
throws SystemException
- Throws:
SystemException
getFileEntry
public static DLFileEntry getFileEntry(long fileEntryId)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
getFileEntry
public static DLFileEntry getFileEntry(long groupId,
long folderId,
String title)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
getFileEntryByUuidAndGroupId
public static DLFileEntry getFileEntryByUuidAndGroupId(String uuid,
long groupId)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
getFileEntryLock
public static Lock getFileEntryLock(long fileEntryId)
getFoldersFileEntriesCount
public static int getFoldersFileEntriesCount(long groupId,
List<Long> folderIds,
int status)
throws SystemException
- Throws:
SystemException
getGroupFileEntries
public static List<DLFileEntry> getGroupFileEntries(long groupId,
long userId,
long rootFolderId,
int start,
int end,
OrderByComparator obc)
throws SystemException
- Throws:
SystemException
getGroupFileEntries
public static List<DLFileEntry> getGroupFileEntries(long groupId,
long userId,
long rootFolderId,
String[] mimeTypes,
int status,
int start,
int end,
OrderByComparator obc)
throws SystemException
- Throws:
SystemException
getGroupFileEntriesCount
public static int getGroupFileEntriesCount(long groupId,
long userId,
long rootFolderId)
throws SystemException
- Throws:
SystemException
getGroupFileEntriesCount
public static int getGroupFileEntriesCount(long groupId,
long userId,
long rootFolderId,
String[] mimeTypes,
int status)
throws SystemException
- Throws:
SystemException
hasFileEntryLock
public static boolean hasFileEntryLock(long fileEntryId)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
isFileEntryCheckedOut
public static boolean isFileEntryCheckedOut(long fileEntryId)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
lockFileEntry
public static Lock lockFileEntry(long fileEntryId)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
lockFileEntry
public static Lock lockFileEntry(long fileEntryId,
String owner,
long expirationTime)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
moveFileEntry
public static DLFileEntry moveFileEntry(long fileEntryId,
long newFolderId,
ServiceContext serviceContext)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
refreshFileEntryLock
public static Lock refreshFileEntryLock(String lockUuid,
long expirationTime)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
revertFileEntry
public static void revertFileEntry(long fileEntryId,
String version,
ServiceContext serviceContext)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
unlockFileEntry
public static void unlockFileEntry(long fileEntryId)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
unlockFileEntry
public static void unlockFileEntry(long fileEntryId,
String lockUuid)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
updateFileEntry
public static DLFileEntry updateFileEntry(long fileEntryId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
boolean majorVersion,
long fileEntryTypeId,
Map<String,Fields> fieldsMap,
File file,
InputStream is,
long size,
ServiceContext serviceContext)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
verifyFileEntryCheckOut
public static boolean verifyFileEntryCheckOut(long fileEntryId,
String lockUuid)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
verifyFileEntryLock
public static boolean verifyFileEntryLock(long fileEntryId,
String lockUuid)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
getService
public static DLFileEntryService getService()
setService
public void setService(DLFileEntryService service)