|
Liferay 6.1.2-ce-ga3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.liferay.portlet.documentlibrary.service.DLFileEntryServiceUtil
public class DLFileEntryServiceUtil
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.
DLFileEntryService
,
com.liferay.portlet.documentlibrary.service.base.DLFileEntryServiceBaseImpl
,
com.liferay.portlet.documentlibrary.service.impl.DLFileEntryServiceImpl
Constructor Summary | |
---|---|
DLFileEntryServiceUtil()
|
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 DLFileVersion |
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 void |
deleteFileVersion(long fileEntryId,
String version)
|
static DLFileEntry |
fetchFileEntryByImageId(long imageId)
|
static String |
getBeanIdentifier()
Returns the Spring bean ID for this bean. |
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 DLFileEntry |
moveFileEntry(long fileEntryId,
long newFolderId,
ServiceContext serviceContext)
|
static Lock |
refreshFileEntryLock(String lockUuid,
long expirationTime)
|
static void |
revertFileEntry(long fileEntryId,
String version,
ServiceContext serviceContext)
|
static void |
setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean. |
void |
setService(DLFileEntryService service)
Deprecated. |
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 |
Constructor Detail |
---|
public DLFileEntryServiceUtil()
Method Detail |
---|
public static String getBeanIdentifier()
public static void setBeanIdentifier(String beanIdentifier)
beanIdentifier
- the Spring bean ID for this beanpublic 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
PortalException
SystemException
public static DLFileVersion cancelCheckOut(long fileEntryId) throws PortalException, SystemException
PortalException
SystemException
public static void checkInFileEntry(long fileEntryId, boolean major, String changeLog, ServiceContext serviceContext) throws PortalException, SystemException
PortalException
SystemException
public static void checkInFileEntry(long fileEntryId, String lockUuid) throws PortalException, SystemException
PortalException
SystemException
public static DLFileEntry checkOutFileEntry(long fileEntryId) throws PortalException, SystemException
checkOutFileEntry(long, ServiceContext)
PortalException
SystemException
public static DLFileEntry checkOutFileEntry(long fileEntryId, ServiceContext serviceContext) throws PortalException, SystemException
PortalException
SystemException
public static DLFileEntry checkOutFileEntry(long fileEntryId, String owner, long expirationTime) throws PortalException, SystemException
checkOutFileEntry(long, String, long,
ServiceContext)
PortalException
SystemException
public static DLFileEntry checkOutFileEntry(long fileEntryId, String owner, long expirationTime, ServiceContext serviceContext) throws PortalException, SystemException
PortalException
SystemException
public static DLFileEntry copyFileEntry(long groupId, long repositoryId, long fileEntryId, long destFolderId, ServiceContext serviceContext) throws PortalException, SystemException
PortalException
SystemException
public static void deleteFileEntry(long fileEntryId) throws PortalException, SystemException
PortalException
SystemException
public static void deleteFileEntry(long groupId, long folderId, String title) throws PortalException, SystemException
PortalException
SystemException
public static void deleteFileVersion(long fileEntryId, String version) throws PortalException, SystemException
PortalException
SystemException
public static DLFileEntry fetchFileEntryByImageId(long imageId) throws PortalException, SystemException
PortalException
SystemException
public static InputStream getFileAsStream(long fileEntryId, String version) throws PortalException, SystemException
PortalException
SystemException
public static InputStream getFileAsStream(long fileEntryId, String version, boolean incrementCounter) throws PortalException, SystemException
PortalException
SystemException
public static List<DLFileEntry> getFileEntries(long groupId, long folderId, int start, int end, OrderByComparator obc) throws SystemException
SystemException
public static List<DLFileEntry> getFileEntries(long groupId, long folderId, long fileEntryTypeId, int start, int end, OrderByComparator obc) throws SystemException
SystemException
public static List<DLFileEntry> getFileEntries(long groupId, long folderId, String[] mimeTypes, int start, int end, OrderByComparator obc) throws SystemException
SystemException
public static int getFileEntriesCount(long groupId, long folderId) throws SystemException
SystemException
public static int getFileEntriesCount(long groupId, long folderId, long fileEntryTypeId) throws SystemException
SystemException
public static int getFileEntriesCount(long groupId, long folderId, String[] mimeTypes) throws SystemException
SystemException
public static DLFileEntry getFileEntry(long fileEntryId) throws PortalException, SystemException
PortalException
SystemException
public static DLFileEntry getFileEntry(long groupId, long folderId, String title) throws PortalException, SystemException
PortalException
SystemException
public static DLFileEntry getFileEntryByUuidAndGroupId(String uuid, long groupId) throws PortalException, SystemException
PortalException
SystemException
public static Lock getFileEntryLock(long fileEntryId)
public static int getFoldersFileEntriesCount(long groupId, List<Long> folderIds, int status) throws SystemException
SystemException
public static List<DLFileEntry> getGroupFileEntries(long groupId, long userId, long rootFolderId, int start, int end, OrderByComparator obc) throws SystemException
SystemException
public static List<DLFileEntry> getGroupFileEntries(long groupId, long userId, long rootFolderId, String[] mimeTypes, int status, int start, int end, OrderByComparator obc) throws SystemException
SystemException
public static int getGroupFileEntriesCount(long groupId, long userId, long rootFolderId) throws SystemException
SystemException
public static int getGroupFileEntriesCount(long groupId, long userId, long rootFolderId, String[] mimeTypes, int status) throws SystemException
SystemException
public static boolean hasFileEntryLock(long fileEntryId) throws PortalException, SystemException
PortalException
SystemException
public static boolean isFileEntryCheckedOut(long fileEntryId) throws PortalException, SystemException
PortalException
SystemException
public static DLFileEntry moveFileEntry(long fileEntryId, long newFolderId, ServiceContext serviceContext) throws PortalException, SystemException
PortalException
SystemException
public static Lock refreshFileEntryLock(String lockUuid, long expirationTime) throws PortalException, SystemException
PortalException
SystemException
public static void revertFileEntry(long fileEntryId, String version, ServiceContext serviceContext) throws PortalException, SystemException
PortalException
SystemException
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
PortalException
SystemException
public static boolean verifyFileEntryCheckOut(long fileEntryId, String lockUuid) throws PortalException, SystemException
PortalException
SystemException
public static boolean verifyFileEntryLock(long fileEntryId, String lockUuid) throws PortalException, SystemException
PortalException
SystemException
public static DLFileEntryService getService()
public void setService(DLFileEntryService service)
|
Liferay 6.1.2-ce-ga3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |