|
Liferay 6.1.2-ce-ga3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.liferay.portlet.documentlibrary.service.DLAppServiceUtil
public class DLAppServiceUtil
The utility for the d l app remote service. This utility wraps com.liferay.portlet.documentlibrary.service.impl.DLAppServiceImpl
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.
DLAppService
,
com.liferay.portlet.documentlibrary.service.base.DLAppServiceBaseImpl
,
com.liferay.portlet.documentlibrary.service.impl.DLAppServiceImpl
Constructor Summary | |
---|---|
DLAppServiceUtil()
|
Method Summary | |
---|---|
static FileEntry |
addFileEntry(long repositoryId,
long folderId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
byte[] bytes,
ServiceContext serviceContext)
Adds a file entry and associated metadata. |
static FileEntry |
addFileEntry(long repositoryId,
long folderId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
File file,
ServiceContext serviceContext)
Adds a file entry and associated metadata. |
static FileEntry |
addFileEntry(long repositoryId,
long folderId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
InputStream is,
long size,
ServiceContext serviceContext)
Adds a file entry and associated metadata. |
static DLFileShortcut |
addFileShortcut(long repositoryId,
long folderId,
long toFileEntryId,
ServiceContext serviceContext)
Adds a file shortcut to the existing file entry. |
static Folder |
addFolder(long repositoryId,
long parentFolderId,
String name,
String description,
ServiceContext serviceContext)
Adds a folder. |
static String |
addTempFileEntry(long groupId,
long folderId,
String fileName,
String tempFolderName,
File file)
Adds a temporary file entry. |
static String |
addTempFileEntry(long groupId,
long folderId,
String fileName,
String tempFolderName,
InputStream inputStream)
|
static void |
cancelCheckOut(long fileEntryId)
Cancels the check out of the file entry. |
static void |
checkInFileEntry(long fileEntryId,
boolean majorVersion,
String changeLog,
ServiceContext serviceContext)
Checks in the file entry. |
static void |
checkInFileEntry(long fileEntryId,
String lockUuid)
Checks in the file entry using the lock's UUID. |
static void |
checkOutFileEntry(long fileEntryId,
ServiceContext serviceContext)
Check out a file entry. |
static FileEntry |
checkOutFileEntry(long fileEntryId,
String owner,
long expirationTime,
ServiceContext serviceContext)
Checks out the file entry. |
static Folder |
copyFolder(long repositoryId,
long sourceFolderId,
long parentFolderId,
String name,
String description,
ServiceContext serviceContext)
Performs a deep copy of the folder. |
static void |
deleteFileEntry(long fileEntryId)
Deletes the file entry with the primary key. |
static void |
deleteFileEntryByTitle(long repositoryId,
long folderId,
String title)
Deletes the file entry with the title in the folder. |
static void |
deleteFileShortcut(long fileShortcutId)
Deletes the file shortcut with the primary key. |
static void |
deleteFileVersion(long fileEntryId,
String version)
Deletes the file version. |
static void |
deleteFolder(long folderId)
Deletes the folder with the primary key and all of its subfolders and file entries. |
static void |
deleteFolder(long repositoryId,
long parentFolderId,
String name)
Deletes the folder with the name in the parent folder and all of its subfolders and file entries. |
static void |
deleteTempFileEntry(long groupId,
long folderId,
String fileName,
String tempFolderName)
Deletes the temporary file entry. |
static String |
getBeanIdentifier()
Returns the Spring bean ID for this bean. |
static List<FileEntry> |
getFileEntries(long repositoryId,
long folderId)
Returns all the file entries in the folder. |
static List<FileEntry> |
getFileEntries(long repositoryId,
long folderId,
int start,
int end)
Returns a range of all the file entries in the folder. |
static List<FileEntry> |
getFileEntries(long repositoryId,
long folderId,
int start,
int end,
OrderByComparator obc)
Returns an ordered range of all the file entries in the folder. |
static List<FileEntry> |
getFileEntries(long repositoryId,
long folderId,
long fileEntryTypeId)
Returns the file entries with the file entry type in the folder. |
static List<FileEntry> |
getFileEntries(long repositoryId,
long folderId,
long fileEntryTypeId,
int start,
int end)
Returns a range of all the file entries with the file entry type in the folder. |
static List<FileEntry> |
getFileEntries(long repositoryId,
long folderId,
long fileEntryTypeId,
int start,
int end,
OrderByComparator obc)
Returns an ordered range of all the file entries with the file entry type in the folder. |
static List<Object> |
getFileEntriesAndFileShortcuts(long repositoryId,
long folderId,
int status,
int start,
int end)
Returns a range of all the file entries and shortcuts in the folder. |
static int |
getFileEntriesAndFileShortcutsCount(long repositoryId,
long folderId,
int status)
Returns the number of file entries and shortcuts in the folder. |
static int |
getFileEntriesAndFileShortcutsCount(long repositoryId,
long folderId,
int status,
String[] mimeTypes)
Returns the number of file entries and shortcuts in the folder. |
static int |
getFileEntriesCount(long repositoryId,
long folderId)
Returns the number of file entries in the folder. |
static int |
getFileEntriesCount(long repositoryId,
long folderId,
long fileEntryTypeId)
Returns the number of file entries with the file entry type in the folder. |
static FileEntry |
getFileEntry(long fileEntryId)
Returns the file entry with the primary key. |
static FileEntry |
getFileEntry(long groupId,
long folderId,
String title)
Returns the file entry with the title in the folder. |
static FileEntry |
getFileEntryByUuidAndGroupId(String uuid,
long groupId)
Returns the file entry with the UUID and group. |
static DLFileShortcut |
getFileShortcut(long fileShortcutId)
Returns the file shortcut with the primary key. |
static Folder |
getFolder(long folderId)
Returns the folder with the primary key. |
static Folder |
getFolder(long repositoryId,
long parentFolderId,
String name)
Returns the folder with the name in the parent folder. |
static List<Folder> |
getFolders(long repositoryId,
long parentFolderId)
Returns all immediate subfolders of the parent folder. |
static List<Folder> |
getFolders(long repositoryId,
long parentFolderId,
boolean includeMountFolders)
Returns all immediate subfolders of the parent folder, optionally including mount folders for third-party repositories. |
static List<Folder> |
getFolders(long repositoryId,
long parentFolderId,
boolean includeMountFolders,
int start,
int end)
Returns a range of all the immediate subfolders of the parent folder, optionally including mount folders for third-party repositories. |
static List<Folder> |
getFolders(long repositoryId,
long parentFolderId,
boolean includeMountFolders,
int start,
int end,
OrderByComparator obc)
Returns an ordered range of all the immediate subfolders of the parent folder. |
static List<Folder> |
getFolders(long repositoryId,
long parentFolderId,
int start,
int end)
Returns a range of all the immediate subfolders of the parent folder. |
static List<Folder> |
getFolders(long repositoryId,
long parentFolderId,
int start,
int end,
OrderByComparator obc)
Returns an ordered range of all the immediate subfolders of the parent folder. |
static List<Object> |
getFoldersAndFileEntriesAndFileShortcuts(long repositoryId,
long folderId,
int status,
boolean includeMountFolders,
int start,
int end)
Returns a range of all the immediate subfolders, file entries, and file shortcuts in the parent folder. |
static List<Object> |
getFoldersAndFileEntriesAndFileShortcuts(long repositoryId,
long folderId,
int status,
boolean includeMountFolders,
int start,
int end,
OrderByComparator obc)
Returns an ordered range of all the immediate subfolders, file entries, and file shortcuts in the parent folder. |
static List<Object> |
getFoldersAndFileEntriesAndFileShortcuts(long repositoryId,
long folderId,
int status,
String[] mimeTypes,
boolean includeMountFolders,
int start,
int end,
OrderByComparator obc)
|
static int |
getFoldersAndFileEntriesAndFileShortcutsCount(long repositoryId,
long folderId,
int status,
boolean includeMountFolders)
Returns the number of immediate subfolders, file entries, and file shortcuts in the parent folder. |
static int |
getFoldersAndFileEntriesAndFileShortcutsCount(long repositoryId,
long folderId,
int status,
String[] mimeTypes,
boolean includeMountFolders)
|
static int |
getFoldersCount(long repositoryId,
long parentFolderId)
Returns the number of immediate subfolders of the parent folder. |
static int |
getFoldersCount(long repositoryId,
long parentFolderId,
boolean includeMountFolders)
Returns the number of immediate subfolders of the parent folder, optionally including mount folders for third-party repositories. |
static int |
getFoldersFileEntriesCount(long repositoryId,
List<Long> folderIds,
int status)
Returns the number of immediate subfolders and file entries across the folders. |
static List<FileEntry> |
getGroupFileEntries(long groupId,
long userId,
int start,
int end)
Returns an ordered range of all the file entries in the group starting at the repository default parent folder that are stored within the Liferay repository. |
static List<FileEntry> |
getGroupFileEntries(long groupId,
long userId,
int start,
int end,
OrderByComparator obc)
Returns an ordered range of all the file entries in the group that are stored within the Liferay repository. |
static List<FileEntry> |
getGroupFileEntries(long groupId,
long userId,
long rootFolderId,
int start,
int end)
Returns an ordered range of all the file entries in the group starting at the root folder that are stored within the Liferay repository. |
static List<FileEntry> |
getGroupFileEntries(long groupId,
long userId,
long rootFolderId,
int start,
int end,
OrderByComparator obc)
Returns an ordered range of all the file entries in the group starting at the root folder that are stored within the Liferay repository. |
static List<FileEntry> |
getGroupFileEntries(long groupId,
long userId,
long rootFolderId,
String[] mimeTypes,
int status,
int start,
int end,
OrderByComparator obc)
|
static int |
getGroupFileEntriesCount(long groupId,
long userId)
Returns the number of file entries in a group starting at the repository default parent folder that are stored within the Liferay repository. |
static int |
getGroupFileEntriesCount(long groupId,
long userId,
long rootFolderId)
Returns the number of file entries in a group starting at the root folder that are stored within the Liferay repository. |
static int |
getGroupFileEntriesCount(long groupId,
long userId,
long rootFolderId,
String[] mimeTypes,
int status)
|
static List<Folder> |
getMountFolders(long repositoryId,
long parentFolderId)
Returns all immediate subfolders of the parent folder that are used for mounting third-party repositories. |
static List<Folder> |
getMountFolders(long repositoryId,
long parentFolderId,
int start,
int end)
Returns a range of all the immediate subfolders of the parent folder that are used for mounting third-party repositories. |
static List<Folder> |
getMountFolders(long repositoryId,
long parentFolderId,
int start,
int end,
OrderByComparator obc)
Returns an ordered range of all the immediate subfolders of the parent folder that are used for mounting third-party repositories. |
static int |
getMountFoldersCount(long repositoryId,
long parentFolderId)
Returns the number of immediate subfolders of the parent folder that are used for mounting third-party repositories. |
static DLAppService |
getService()
|
static void |
getSubfolderIds(long repositoryId,
List<Long> folderIds,
long folderId)
|
static List<Long> |
getSubfolderIds(long repositoryId,
long folderId)
Returns all the descendant folders of the folder with the primary key. |
static List<Long> |
getSubfolderIds(long repositoryId,
long folderId,
boolean recurse)
Returns descendant folders of the folder with the primary key, optionally limiting to one level deep. |
static String[] |
getTempFileEntryNames(long groupId,
long folderId,
String tempFolderName)
Returns all the temporary file entry names. |
static Lock |
lockFileEntry(long fileEntryId)
Deprecated. checkOutFileEntry(long, ServiceContext) |
static Lock |
lockFileEntry(long fileEntryId,
String owner,
long expirationTime)
Deprecated. checkOutFileEntry(long, String, long,
ServiceContext) |
static Lock |
lockFolder(long repositoryId,
long folderId)
Locks the folder. |
static Lock |
lockFolder(long repositoryId,
long folderId,
String owner,
boolean inheritable,
long expirationTime)
Locks the folder. |
static FileEntry |
moveFileEntry(long fileEntryId,
long newFolderId,
ServiceContext serviceContext)
Moves the file entry to the new folder. |
static Folder |
moveFolder(long folderId,
long parentFolderId,
ServiceContext serviceContext)
Moves the folder to the new parent folder with the primary key. |
static Lock |
refreshFileEntryLock(String lockUuid,
long expirationTime)
Refreshes the lock for the file entry. |
static Lock |
refreshFolderLock(String lockUuid,
long expirationTime)
Refreshes the lock for the folder. |
static void |
revertFileEntry(long fileEntryId,
String version,
ServiceContext serviceContext)
Reverts the file entry to a previous version. |
static Hits |
search(long repositoryId,
SearchContext searchContext)
|
static Hits |
search(long repositoryId,
SearchContext searchContext,
Query query)
|
static void |
setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean. |
void |
setService(DLAppService service)
Deprecated. |
static void |
unlockFileEntry(long fileEntryId)
Deprecated. Use checkInFileEntry(long, boolean, String,
ServiceContext) . |
static void |
unlockFileEntry(long fileEntryId,
String lockUuid)
Deprecated. Use checkInFileEntry(long, String) . |
static void |
unlockFolder(long repositoryId,
long folderId,
String lockUuid)
Unlocks the folder. |
static void |
unlockFolder(long repositoryId,
long parentFolderId,
String name,
String lockUuid)
Unlocks the folder. |
static FileEntry |
updateFileEntry(long fileEntryId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
boolean majorVersion,
byte[] bytes,
ServiceContext serviceContext)
Updates a file entry and associated metadata based on a byte array object. |
static FileEntry |
updateFileEntry(long fileEntryId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
boolean majorVersion,
File file,
ServiceContext serviceContext)
Updates a file entry and associated metadata based on a File
object. |
static FileEntry |
updateFileEntry(long fileEntryId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
boolean majorVersion,
InputStream is,
long size,
ServiceContext serviceContext)
Updates a file entry and associated metadata based on an InputStream object. |
static FileEntry |
updateFileEntryAndCheckIn(long fileEntryId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
boolean majorVersion,
File file,
ServiceContext serviceContext)
|
static FileEntry |
updateFileEntryAndCheckIn(long fileEntryId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
boolean majorVersion,
InputStream is,
long size,
ServiceContext serviceContext)
|
static DLFileShortcut |
updateFileShortcut(long fileShortcutId,
long folderId,
long toFileEntryId,
ServiceContext serviceContext)
Updates a file shortcut to the existing file entry. |
static Folder |
updateFolder(long folderId,
String name,
String description,
ServiceContext serviceContext)
Updates the folder. |
static boolean |
verifyFileEntryCheckOut(long repositoryId,
long fileEntryId,
String lockUuid)
Returns true if the file entry is checked out. |
static boolean |
verifyFileEntryLock(long repositoryId,
long fileEntryId,
String lockUuid)
|
static boolean |
verifyInheritableLock(long repositoryId,
long folderId,
String lockUuid)
Returns true if the inheritable lock exists. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DLAppServiceUtil()
Method Detail |
---|
public static String getBeanIdentifier()
public static void setBeanIdentifier(String beanIdentifier)
beanIdentifier
- the Spring bean ID for this beanpublic static FileEntry addFileEntry(long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String description, String changeLog, byte[] bytes, ServiceContext serviceContext) throws PortalException, SystemException
This method takes two file names, the sourceFileName
and the
title
. The sourceFileName
corresponds to the
name of the actual file being uploaded. The title
corresponds to a name the client wishes to assign this file after it has
been uploaded to the portal. If it is null
, the
sourceFileName
will be used.
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the file entry's parent foldersourceFileName
- the original file's namemimeType
- the file's MIME typetitle
- the name to be assigned to the file (optionally null
)description
- the file's descriptionchangeLog
- the file's version change logbytes
- the file's data (optionally null
)serviceContext
- the service context to be applied. Can set the
asset category IDs, asset tag names, and expando bridge
attributes for the file entry. In a Liferay repository, it may
include: PortalException
- if the parent folder could not be found or if the
file entry's information was invalid
SystemException
- if a system exception occurredpublic static FileEntry addFileEntry(long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String description, String changeLog, File file, ServiceContext serviceContext) throws PortalException, SystemException
File
object.
This method takes two file names, the sourceFileName
and the
title
. The sourceFileName
corresponds to the
name of the actual file being uploaded. The title
corresponds to a name the client wishes to assign this file after it has
been uploaded to the portal. If it is null
, the
sourceFileName
will be used.
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the file entry's parent foldersourceFileName
- the original file's namemimeType
- the file's MIME typetitle
- the name to be assigned to the file (optionally null
)description
- the file's descriptionchangeLog
- the file's version change logfile
- the file's data (optionally null
)serviceContext
- the service context to be applied. Can set the
asset category IDs, asset tag names, and expando bridge
attributes for the file entry. In a Liferay repository, it may
include: PortalException
- if the parent folder could not be found or if the
file entry's information was invalid
SystemException
- if a system exception occurredpublic static FileEntry addFileEntry(long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String description, String changeLog, InputStream is, long size, ServiceContext serviceContext) throws PortalException, SystemException
InputStream
object.
This method takes two file names, the sourceFileName
and the
title
. The sourceFileName
corresponds to the
name of the actual file being uploaded. The title
corresponds to a name the client wishes to assign this file after it has
been uploaded to the portal. If it is null
, the
sourceFileName
will be used.
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the file entry's parent foldersourceFileName
- the original file's namemimeType
- the file's MIME typetitle
- the name to be assigned to the file (optionally null
)description
- the file's descriptionchangeLog
- the file's version change logis
- the file's data (optionally null
)size
- the file's size (optionally 0
)serviceContext
- the service context to be applied. Can set the
asset category IDs, asset tag names, and expando bridge
attributes for the file entry. In a Liferay repository, it may
include: PortalException
- if the parent folder could not be found or if the
file entry's information was invalid
SystemException
- if a system exception occurredpublic static DLFileShortcut addFileShortcut(long repositoryId, long folderId, long toFileEntryId, ServiceContext serviceContext) throws PortalException, SystemException
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the file shortcut's parent foldertoFileEntryId
- the primary key of the file shortcut's file entryserviceContext
- the service context to be applied. Can set the
asset category IDs, asset tag names, and expando bridge
attributes for the file entry.
PortalException
- if the parent folder or file entry could not be
found, or if the file shortcut's information was invalid
SystemException
- if a system exception occurredpublic static Folder addFolder(long repositoryId, long parentFolderId, String name, String description, ServiceContext serviceContext) throws PortalException, SystemException
repositoryId
- the primary key of the repositoryparentFolderId
- the primary key of the folder's parent foldername
- the folder's namedescription
- the folder's descriptionserviceContext
- the service context to be applied. In a Liferay
repository, it may include boolean mountPoint specifying whether
folder is a facade for mounting a third-party repository
PortalException
- if the parent folder could not be found or if the
new folder's information was invalid
SystemException
- if a system exception occurredpublic static String addTempFileEntry(long groupId, long folderId, String fileName, String tempFolderName, File file) throws PortalException, SystemException, IOException
This allows a client to upload a file into a temporary location and manipulate its metadata prior to making it available for public usage. This is different from checking in and checking out a file entry.
groupId
- the primary key of the groupfolderId
- the primary key of the folder where the file entry will
eventually residefileName
- the file's original nametempFolderName
- the temporary folder's namefile
- Name the file's original name
IOException
- if a problem occurred in the access or storage of the
file
PortalException
- if the file name was invalid
SystemException
- if a system exception occurredTempFileUtil
public static String addTempFileEntry(long groupId, long folderId, String fileName, String tempFolderName, InputStream inputStream) throws PortalException, SystemException
PortalException
SystemException
public static void cancelCheckOut(long fileEntryId) throws PortalException, SystemException
When a file entry is checked out, a PWC (private working copy) is created and the original file entry is locked. A client can make as many changes to the PWC as he desires without those changes being visible to other users. If the user is satisfied with the changes, he may elect to check in his changes, resulting in a new file version based on the PWC; the PWC will be removed and the file entry will be unlocked. If the user is not satisfied with the changes, he may elect to cancel his check out; this results in the deletion of the PWC and unlocking of the file entry.
fileEntryId
- the primary key of the file entry to cancel the
checkout
PortalException
- if the file entry could not be found
SystemException
- if a system exception occurredcheckInFileEntry(long, boolean, String, ServiceContext)
,
#checkOutFileEntry(long)
public static void checkInFileEntry(long fileEntryId, boolean majorVersion, String changeLog, ServiceContext serviceContext) throws PortalException, SystemException
When a file entry is checked out, a PWC (private working copy) is created and the original file entry is locked. A client can make as many changes to the PWC as he desires without those changes being visible to other users. If the user is satisfied with the changes, he may elect to check in his changes, resulting in a new file version based on the PWC; the PWC will be removed and the file entry will be unlocked. If the user is not satisfied with the changes, he may elect to cancel his check out; this results in the deletion of the PWC and unlocking of the file entry.
fileEntryId
- the primary key of the file entry to check inmajorVersion
- whether the new file version is a major versionchangeLog
- the file's version change logserviceContext
- the service context to be applied
PortalException
- if the file entry could not be found
SystemException
- if a system exception occurredcancelCheckOut(long)
,
#checkOutFileEntry(long)
public static void checkInFileEntry(long fileEntryId, String lockUuid) throws PortalException, SystemException
When a file entry is checked out, a PWC (private working copy) is created and the original file entry is locked. A client can make as many changes to the PWC as he desires without those changes being visible to other users. If the user is satisfied with the changes, he may elect to check in his changes, resulting in a new file version based on the PWC; the PWC will be removed and the file entry will be unlocked. If the user is not satisfied with the changes, he may elect to cancel his check out; this results in the deletion of the PWC and unlocking of the file entry.
fileEntryId
- the primary key of the file entry to check inlockUuid
- the lock's universally unique identifier
PortalException
- if the file entry could not be found
SystemException
- if a system exception occurredcancelCheckOut(long)
,
#checkOutFileEntry(long, String, long)
public static void checkOutFileEntry(long fileEntryId, ServiceContext serviceContext) throws PortalException, SystemException
When a file entry is checked out, a PWC (private working copy) is created and the original file entry is locked. A client can make as many changes to the PWC as he desires without those changes being visible to other users. If the user is satisfied with the changes, he may elect to check in his changes, resulting in a new file version based on the PWC; the PWC will be removed and the file entry will be unlocked. If the user is not satisfied with the changes, he may elect to cancel his check out; this results in the deletion of the PWC and unlocking of the file entry.
fileEntryId
- the file entry to check outserviceContext
- the service context to be applied
PortalException
- if the file entry could not be found
SystemException
- if a system exception occurredcancelCheckOut(long)
,
checkInFileEntry(long, boolean, String, ServiceContext)
public static FileEntry checkOutFileEntry(long fileEntryId, String owner, long expirationTime, ServiceContext serviceContext) throws PortalException, SystemException
When a file entry is checked out, a PWC (private working copy) is created and the original file entry is locked. A client can make as many changes to the PWC as he desires without those changes being visible to other users. If the user is satisfied with the changes, he may elect to check in his changes, resulting in a new file version based on the PWC; the PWC will be removed and the file entry will be unlocked. If the user is not satisfied with the changes, he may elect to cancel his check out; this results in the deletion of the PWC and unlocking of the file entry.
fileEntryId
- the file entry to check outowner
- the owner string for the checkout (optionally
null
)expirationTime
- the time in milliseconds before the lock expires.
If the value is 0
, the default expiration time will
be used from portal.properties>.
serviceContext
- the service context to be applied
Returns:
the file entry
Throws:
PortalException
- if the file entry could not be found
SystemException
- if a system exception occurred
See Also:
cancelCheckOut(long)
,
checkInFileEntry(long, String)
copyFolder
public static Folder copyFolder(long repositoryId,
long sourceFolderId,
long parentFolderId,
String name,
String description,
ServiceContext serviceContext)
throws PortalException,
SystemException
- Performs a deep copy of the folder.
- Parameters:
repositoryId
- the primary key of the repositorysourceFolderId
- the primary key of the folder to copyparentFolderId
- the primary key of the new folder's parent foldername
- the new folder's namedescription
- the new folder's descriptionserviceContext
- the service context to be applied
- Returns:
- the folder
- Throws:
PortalException
- if the source folder or the new parent folder
could not be found or if the new folder's information was invalid
SystemException
- if a system exception occurred
deleteFileEntry
public static void deleteFileEntry(long fileEntryId)
throws PortalException,
SystemException
- Deletes the file entry with the primary key.
- Parameters:
fileEntryId
- the primary key of the file entry
- Throws:
PortalException
- if the file entry could not be found
SystemException
- if a system exception occurred
deleteFileEntryByTitle
public static void deleteFileEntryByTitle(long repositoryId,
long folderId,
String title)
throws PortalException,
SystemException
- Deletes the file entry with the title in the folder.
- Parameters:
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the file entry's parent foldertitle
- the file entry's title
- Throws:
PortalException
- if the file entry could not be found
SystemException
- if a system exception occurred
deleteFileShortcut
public static void deleteFileShortcut(long fileShortcutId)
throws PortalException,
SystemException
- Deletes the file shortcut with the primary key. This method is only
supported by the Liferay repository.
- Parameters:
fileShortcutId
- the primary key of the file shortcut
- Throws:
PortalException
- if the file shortcut could not be found
SystemException
- if a system exception occurred
deleteFileVersion
public static void deleteFileVersion(long fileEntryId,
String version)
throws PortalException,
SystemException
- Deletes the file version. File versions can only be deleted if it is
approved and there are other approved file versions available. This
method is only supported by the Liferay repository.
- Parameters:
fileEntryId
- the primary key of the file entryversion
- the version label of the file version
- Throws:
PortalException
- if the file version could not be found or invalid
SystemException
- if a system exception occurred
deleteFolder
public static void deleteFolder(long folderId)
throws PortalException,
SystemException
- Deletes the folder with the primary key and all of its subfolders and
file entries.
- Parameters:
folderId
- the primary key of the folder
- Throws:
PortalException
- if the folder could not be found
SystemException
- if a system exception occurred
deleteFolder
public static void deleteFolder(long repositoryId,
long parentFolderId,
String name)
throws PortalException,
SystemException
- Deletes the folder with the name in the parent folder and all of its
subfolders and file entries.
- Parameters:
repositoryId
- the primary key of the repositoryparentFolderId
- the primary key of the folder's parent foldername
- the folder's name
- Throws:
PortalException
- if the folder could not be found
SystemException
- if a system exception occurred
deleteTempFileEntry
public static void deleteTempFileEntry(long groupId,
long folderId,
String fileName,
String tempFolderName)
throws PortalException,
SystemException
- Deletes the temporary file entry.
- Parameters:
groupId
- the primary key of the groupfolderId
- the primary key of the folder where the file entry was
eventually to residefileName
- the file's original nametempFolderName
- the temporary folder's name
- Throws:
PortalException
- if the file name was invalid
SystemException
- if a system exception occurred- See Also:
TempFileUtil
getFileEntries
public static List<FileEntry> getFileEntries(long repositoryId,
long folderId)
throws PortalException,
SystemException
- Returns all the file entries in the folder.
- Parameters:
repositoryId
- the primary key of the file entry's repositoryfolderId
- the primary key of the file entry's folder
- Returns:
- the file entries in the folder
- Throws:
PortalException
- if the folder could not be found
SystemException
- if a system exception occurred
getFileEntries
public static List<FileEntry> getFileEntries(long repositoryId,
long folderId,
int start,
int end)
throws PortalException,
SystemException
- Returns a range of all the file entries in the folder.
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil.ALL_POS
will return the full
result set.
- Parameters:
repositoryId
- the primary key of the file entry's repositoryfolderId
- the primary key of the file entry's folderstart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)
- Returns:
- the range of file entries in the folder
- Throws:
PortalException
- if the folder could not be found
SystemException
- if a system exception occurred
getFileEntries
public static List<FileEntry> getFileEntries(long repositoryId,
long folderId,
int start,
int end,
OrderByComparator obc)
throws PortalException,
SystemException
- Returns an ordered range of all the file entries in the folder.
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil.ALL_POS
will return the full
result set.
- Parameters:
repositoryId
- the primary key of the file entry's repositoryfolderId
- the primary key of the file entry's folderstart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)obc
- the comparator to order the file entries (optionally
null
)
- Returns:
- the range of file entries in the folder ordered by comparator
obc
- Throws:
PortalException
- if the folder could not be found
SystemException
- if a system exception occurred
getFileEntries
public static List<FileEntry> getFileEntries(long repositoryId,
long folderId,
long fileEntryTypeId)
throws PortalException,
SystemException
- Returns the file entries with the file entry type in the folder.
- Parameters:
repositoryId
- the primary key of the file entry's repositoryfolderId
- the primary key of the file entry's folderfileEntryTypeId
- the primary key of the file entry type
- Returns:
- the file entries with the file entry type in the folder
- Throws:
PortalException
- if the folder could not be found
SystemException
- if a system exception occurred
getFileEntries
public static List<FileEntry> getFileEntries(long repositoryId,
long folderId,
long fileEntryTypeId,
int start,
int end)
throws PortalException,
SystemException
- Returns a range of all the file entries with the file entry type in the
folder.
- Parameters:
repositoryId
- the primary key of the file entry's repositoryfolderId
- the primary key of the file entry's folderfileEntryTypeId
- the primary key of the file entry typestart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)
- Returns:
- the file entries in the folder
- Throws:
PortalException
- if the folder could not be found
SystemException
- if a system exception occurred
getFileEntries
public static List<FileEntry> getFileEntries(long repositoryId,
long folderId,
long fileEntryTypeId,
int start,
int end,
OrderByComparator obc)
throws PortalException,
SystemException
- Returns an ordered range of all the file entries with the file entry type
in the folder.
- Parameters:
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the folderfileEntryTypeId
- the primary key of the file entry typestart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)obc
- the comparator to order the results by (optionally
null
)
- Returns:
- the range of file entries with the file entry type in the folder
ordered by
null
- Throws:
PortalException
- if the folder could not be found
SystemException
- if a system exception occurred
getFileEntriesAndFileShortcuts
public static List<Object> getFileEntriesAndFileShortcuts(long repositoryId,
long folderId,
int status,
int start,
int end)
throws PortalException,
SystemException
- Returns a range of all the file entries and shortcuts in the folder.
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil.ALL_POS
will return the full
result set.
- Parameters:
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the folderstatus
- the workflow statusstart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)
- Returns:
- the range of file entries and shortcuts in the folder
- Throws:
PortalException
- if the folder could not be found
SystemException
- if a system exception occurred
getFileEntriesAndFileShortcutsCount
public static int getFileEntriesAndFileShortcutsCount(long repositoryId,
long folderId,
int status)
throws PortalException,
SystemException
- Returns the number of file entries and shortcuts in the folder.
- Parameters:
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the folderstatus
- the workflow status
- Returns:
- the number of file entries and shortcuts in the folder
- Throws:
PortalException
- if the folder ould not be found
SystemException
- if a system exception occurred
getFileEntriesAndFileShortcutsCount
public static int getFileEntriesAndFileShortcutsCount(long repositoryId,
long folderId,
int status,
String[] mimeTypes)
throws PortalException,
SystemException
- Returns the number of file entries and shortcuts in the folder.
- Parameters:
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the folderstatus
- the workflow statusmimeTypes
- allowed media types
- Returns:
- the number of file entries and shortcuts in the folder
- Throws:
PortalException
- if the folder ould not be found
SystemException
- if a system exception occurred
getFileEntriesCount
public static int getFileEntriesCount(long repositoryId,
long folderId)
throws PortalException,
SystemException
- Returns the number of file entries in the folder.
- Parameters:
repositoryId
- the primary key of the file entry's repositoryfolderId
- the primary key of the file entry's folder
- Returns:
- the number of file entries in the folder
- Throws:
PortalException
- if the folder could not be found
SystemException
- if a system exception occurred
getFileEntriesCount
public static int getFileEntriesCount(long repositoryId,
long folderId,
long fileEntryTypeId)
throws PortalException,
SystemException
- Returns the number of file entries with the file entry type in the
folder.
- Parameters:
repositoryId
- the primary key of the file entry's repositoryfolderId
- the primary key of the file entry's folderfileEntryTypeId
- the primary key of the file entry type
- Returns:
- the number of file entries with the file entry type in the folder
- Throws:
PortalException
- if the folder could not be found
SystemException
- if a system exception occurred
getFileEntry
public static FileEntry getFileEntry(long fileEntryId)
throws PortalException,
SystemException
- Returns the file entry with the primary key.
- Parameters:
fileEntryId
- the primary key of the file entry
- Returns:
- the file entry with the primary key
- Throws:
PortalException
- if the file entry could not be found
SystemException
- if a system exception occurred
getFileEntry
public static FileEntry getFileEntry(long groupId,
long folderId,
String title)
throws PortalException,
SystemException
- Returns the file entry with the title in the folder.
- Parameters:
groupId
- the primary key of the file entry's groupfolderId
- the primary key of the file entry's foldertitle
- the file entry's title
- Returns:
- the file entry with the title in the folder
- Throws:
PortalException
- if the file entry could not be found
SystemException
- if a system exception occurred
getFileEntryByUuidAndGroupId
public static FileEntry getFileEntryByUuidAndGroupId(String uuid,
long groupId)
throws PortalException,
SystemException
- Returns the file entry with the UUID and group.
- Parameters:
uuid
- the file entry's universally unique identifiergroupId
- the primary key of the file entry's group
- Returns:
- the file entry with the UUID and group
- Throws:
PortalException
- if the file entry could not be found
SystemException
- if a system exception occurred
getFileShortcut
public static DLFileShortcut getFileShortcut(long fileShortcutId)
throws PortalException,
SystemException
- Returns the file shortcut with the primary key. This method is only
supported by the Liferay repository.
- Parameters:
fileShortcutId
- the primary key of the file shortcut
- Returns:
- the file shortcut with the primary key
- Throws:
PortalException
- if the file shortcut could not be found
SystemException
- if a system exception occurred
getFolder
public static Folder getFolder(long folderId)
throws PortalException,
SystemException
- Returns the folder with the primary key.
- Parameters:
folderId
- the primary key of the folder
- Returns:
- the folder with the primary key
- Throws:
PortalException
- if the folder could not be found
SystemException
- if a system exception occurred
getFolder
public static Folder getFolder(long repositoryId,
long parentFolderId,
String name)
throws PortalException,
SystemException
- Returns the folder with the name in the parent folder.
- Parameters:
repositoryId
- the primary key of the folder's repositoryparentFolderId
- the primary key of the folder's parent foldername
- the folder's name
- Returns:
- the folder with the name in the parent folder
- Throws:
PortalException
- if the folder could not be found
SystemException
- if a system exception occurred
getFolders
public static List<Folder> getFolders(long repositoryId,
long parentFolderId)
throws PortalException,
SystemException
- Returns all immediate subfolders of the parent folder.
- Parameters:
repositoryId
- the primary key of the folder's repositoryparentFolderId
- the primary key of the folder's parent folder
- Returns:
- the immediate subfolders of the parent folder
- Throws:
PortalException
- if the parent folder could not be found
SystemException
- if a system exception occurred
getFolders
public static List<Folder> getFolders(long repositoryId,
long parentFolderId,
boolean includeMountFolders)
throws PortalException,
SystemException
- Returns all immediate subfolders of the parent folder, optionally
including mount folders for third-party repositories.
- Parameters:
repositoryId
- the primary key of the folder's repositoryparentFolderId
- the primary key of the folder's parent folderincludeMountFolders
- whether to include mount folders for
third-party repositories
- Returns:
- the immediate subfolders of the parent folder
- Throws:
PortalException
- if the parent folder could not be found
SystemException
- if a system exception occurred
getFolders
public static List<Folder> getFolders(long repositoryId,
long parentFolderId,
boolean includeMountFolders,
int start,
int end)
throws PortalException,
SystemException
- Returns a range of all the immediate subfolders of the parent folder,
optionally including mount folders for third-party repositories.
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil.ALL_POS
will return the full
result set.
- Parameters:
repositoryId
- the primary key of the folder's repositoryparentFolderId
- the primary key of the folder's parent folderincludeMountFolders
- whether to include mount folders for
third-party repositoriesstart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)
- Returns:
- the range of immediate subfolders of the parent folder
- Throws:
PortalException
- if the parent folder could not be found
SystemException
- if a system exception occurred
getFolders
public static List<Folder> getFolders(long repositoryId,
long parentFolderId,
boolean includeMountFolders,
int start,
int end,
OrderByComparator obc)
throws PortalException,
SystemException
- Returns an ordered range of all the immediate subfolders of the parent
folder.
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil.ALL_POS
will return the full
result set.
- Parameters:
repositoryId
- the primary key of the folder's repositoryparentFolderId
- the primary key of the folder's parent folderincludeMountFolders
- whether to include mount folders for
third-party repositoriesstart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)obc
- the comparator to order the folders (optionally
null
)
- Returns:
- the range of immediate subfolders of the parent folder ordered by
comparator
obc
- Throws:
PortalException
- if the parent folder could not be found
SystemException
- if a system exception occurred
getFolders
public static List<Folder> getFolders(long repositoryId,
long parentFolderId,
int start,
int end)
throws PortalException,
SystemException
- Returns a range of all the immediate subfolders of the parent folder.
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil.ALL_POS
will return the full
result set.
- Parameters:
repositoryId
- the primary key of the folder's repositoryparentFolderId
- the primary key of the folder's parent folderstart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)
- Returns:
- the range of immediate subfolders of the parent folder
- Throws:
PortalException
- if the parent folder could not be found
SystemException
- if a system exception occurred
getFolders
public static List<Folder> getFolders(long repositoryId,
long parentFolderId,
int start,
int end,
OrderByComparator obc)
throws PortalException,
SystemException
- Returns an ordered range of all the immediate subfolders of the parent
folder.
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil.ALL_POS
will return the full
result set.
- Parameters:
repositoryId
- the primary key of the folder's repositoryparentFolderId
- the primary key of the folder's parent folderstart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)obc
- the comparator to order the folders (optionally
null
)
- Returns:
- the range of immediate subfolders of the parent folder ordered by
comparator
obc
- Throws:
PortalException
- if the parent folder could not be found
SystemException
- if a system exception occurred
getFoldersAndFileEntriesAndFileShortcuts
public static List<Object> getFoldersAndFileEntriesAndFileShortcuts(long repositoryId,
long folderId,
int status,
boolean includeMountFolders,
int start,
int end)
throws PortalException,
SystemException
- Returns a range of all the immediate subfolders, file entries, and file
shortcuts in the parent folder.
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil.ALL_POS
will return the full
result set.
- Parameters:
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the parent folderstatus
- the workflow statusincludeMountFolders
- whether to include mount folders for
third-party repositoriesstart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)
- Returns:
- the range of immediate subfolders, file entries, and file
shortcuts in the parent folder ordered by comparator
obc
- Throws:
PortalException
- if the parent folder could not be found
SystemException
- if a system exception occurred
getFoldersAndFileEntriesAndFileShortcuts
public static List<Object> getFoldersAndFileEntriesAndFileShortcuts(long repositoryId,
long folderId,
int status,
boolean includeMountFolders,
int start,
int end,
OrderByComparator obc)
throws PortalException,
SystemException
- Returns an ordered range of all the immediate subfolders, file entries,
and file shortcuts in the parent folder.
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil.ALL_POS
will return the full
result set.
- Parameters:
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the parent folderstatus
- the workflow statusincludeMountFolders
- whether to include mount folders for
third-party repositoriesstart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)obc
- the comparator to order the results (optionally
null
)
- Returns:
- the range of immediate subfolders, file entries, and file
shortcuts in the parent folder ordered by comparator
obc
- Throws:
PortalException
- if the parent folder could not be found
SystemException
- if a system exception occurred
getFoldersAndFileEntriesAndFileShortcuts
public static List<Object> getFoldersAndFileEntriesAndFileShortcuts(long repositoryId,
long folderId,
int status,
String[] mimeTypes,
boolean includeMountFolders,
int start,
int end,
OrderByComparator obc)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
getFoldersAndFileEntriesAndFileShortcutsCount
public static int getFoldersAndFileEntriesAndFileShortcutsCount(long repositoryId,
long folderId,
int status,
boolean includeMountFolders)
throws PortalException,
SystemException
- Returns the number of immediate subfolders, file entries, and file
shortcuts in the parent folder.
- Parameters:
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the parent folderstatus
- the workflow statusincludeMountFolders
- whether to include mount folders for
third-party repositories
- Returns:
- the number of immediate subfolders, file entries, and file
shortcuts in the parent folder
- Throws:
PortalException
- if the folder could not be found
SystemException
- if a system exception occurred
getFoldersAndFileEntriesAndFileShortcutsCount
public static int getFoldersAndFileEntriesAndFileShortcutsCount(long repositoryId,
long folderId,
int status,
String[] mimeTypes,
boolean includeMountFolders)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
getFoldersCount
public static int getFoldersCount(long repositoryId,
long parentFolderId)
throws PortalException,
SystemException
- Returns the number of immediate subfolders of the parent folder.
- Parameters:
repositoryId
- the primary key of the folder's repositoryparentFolderId
- the primary key of the folder's parent folder
- Returns:
- the number of immediate subfolders of the parent folder
- Throws:
PortalException
- if the parent folder could not be found
SystemException
- if a system exception occurred
getFoldersCount
public static int getFoldersCount(long repositoryId,
long parentFolderId,
boolean includeMountFolders)
throws PortalException,
SystemException
- Returns the number of immediate subfolders of the parent folder,
optionally including mount folders for third-party repositories.
- Parameters:
repositoryId
- the primary key of the folder's repositoryparentFolderId
- the primary key of the folder's parent folderincludeMountFolders
- whether to include mount folders for
third-party repositories
- Returns:
- the number of immediate subfolders of the parent folder
- Throws:
PortalException
- if the parent folder could not be found
SystemException
- if a system exception occurred
getFoldersFileEntriesCount
public static int getFoldersFileEntriesCount(long repositoryId,
List<Long> folderIds,
int status)
throws PortalException,
SystemException
- Returns the number of immediate subfolders and file entries across the
folders.
- Parameters:
repositoryId
- the primary key of the repositoryfolderIds
- the primary keys of folders from which to count
immediate subfolders and file entriesstatus
- the workflow status
- Returns:
- the number of immediate subfolders and file entries across the
folders
- Throws:
PortalException
- if the repository could not be found
SystemException
- if a system exception occurred
getGroupFileEntries
public static List<FileEntry> getGroupFileEntries(long groupId,
long userId,
int start,
int end)
throws PortalException,
SystemException
- Returns an ordered range of all the file entries in the group starting at
the repository default parent folder that are stored within the Liferay
repository. This method is primarily used to search for recently modified
file entries. It can be limited to the file entries modified by a given
user.
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil.ALL_POS
will return the full
result set.
- Parameters:
groupId
- the primary key of the groupuserId
- the primary key of the user who created the file
(optionally 0
)start
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)
- Returns:
- the range of matching file entries ordered by date modified
- Throws:
PortalException
- if the group could not be found
SystemException
- if a system exception occurred
getGroupFileEntries
public static List<FileEntry> getGroupFileEntries(long groupId,
long userId,
int start,
int end,
OrderByComparator obc)
throws PortalException,
SystemException
- Returns an ordered range of all the file entries in the group that are
stored within the Liferay repository. This method is primarily used to
search for recently modified file entries. It can be limited to the file
entries modified by a given user.
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil.ALL_POS
will return the full
result set.
- Parameters:
groupId
- the primary key of the groupuserId
- the primary key of the user who created the file
(optionally 0
)start
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)obc
- the comparator to order the file entries (optionally
null
)
- Returns:
- the range of matching file entries ordered by comparator
obc
- Throws:
PortalException
- if the group could not be found
SystemException
- if a system exception occurred
getGroupFileEntries
public static List<FileEntry> getGroupFileEntries(long groupId,
long userId,
long rootFolderId,
int start,
int end)
throws PortalException,
SystemException
- Returns an ordered range of all the file entries in the group starting at
the root folder that are stored within the Liferay repository. This
method is primarily used to search for recently modified file entries. It
can be limited to the file entries modified by a given user.
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil.ALL_POS
will return the full
result set.
- Parameters:
groupId
- the primary key of the groupuserId
- the primary key of the user who created the file
(optionally 0
)rootFolderId
- the primary key of the root folder to begin the
searchstart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)
- Returns:
- the range of matching file entries ordered by date modified
- Throws:
PortalException
- if the group could not be found
SystemException
- if a system exception occurred
getGroupFileEntries
public static List<FileEntry> getGroupFileEntries(long groupId,
long userId,
long rootFolderId,
int start,
int end,
OrderByComparator obc)
throws PortalException,
SystemException
- Returns an ordered range of all the file entries in the group starting at
the root folder that are stored within the Liferay repository. This
method is primarily used to search for recently modified file entries. It
can be limited to the file entries modified by a given user.
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil.ALL_POS
will return the full
result set.
- Parameters:
groupId
- the primary key of the groupuserId
- the primary key of the user who created the file
(optionally 0
)rootFolderId
- the primary key of the root folder to begin the
searchstart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)obc
- the comparator to order the file entries (optionally
null
)
- Returns:
- the range of matching file entries ordered by comparator
obc
- Throws:
PortalException
- if the group could not be found
SystemException
- if a system exception occurred
getGroupFileEntries
public static List<FileEntry> getGroupFileEntries(long groupId,
long userId,
long rootFolderId,
String[] mimeTypes,
int status,
int start,
int end,
OrderByComparator obc)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
getGroupFileEntriesCount
public static int getGroupFileEntriesCount(long groupId,
long userId)
throws PortalException,
SystemException
- Returns the number of file entries in a group starting at the repository
default parent folder that are stored within the Liferay repository. This
method is primarily used to search for recently modified file entries. It
can be limited to the file entries modified by a given user.
- Parameters:
groupId
- the primary key of the groupuserId
- the primary key of the user who created the file
(optionally 0
)
- Returns:
- the number of matching file entries
- Throws:
PortalException
- if the group could not be found
SystemException
- if a system exception occurred
getGroupFileEntriesCount
public static int getGroupFileEntriesCount(long groupId,
long userId,
long rootFolderId)
throws PortalException,
SystemException
- Returns the number of file entries in a group starting at the root folder
that are stored within the Liferay repository. This method is primarily
used to search for recently modified file entries. It can be limited to
the file entries modified by a given user.
- Parameters:
groupId
- the primary key of the groupuserId
- the primary key of the user who created the file
(optionally 0
)rootFolderId
- the primary key of the root folder to begin the
search
- Returns:
- the number of matching file entries
- Throws:
PortalException
- if the group could not be found
SystemException
- if a system exception occurred
getGroupFileEntriesCount
public static int getGroupFileEntriesCount(long groupId,
long userId,
long rootFolderId,
String[] mimeTypes,
int status)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
getMountFolders
public static List<Folder> getMountFolders(long repositoryId,
long parentFolderId)
throws PortalException,
SystemException
- Returns all immediate subfolders of the parent folder that are used for
mounting third-party repositories. This method is only supported by the
Liferay repository.
- Parameters:
repositoryId
- the primary key of the folder's repositoryparentFolderId
- the primary key of the folder's parent folder
- Returns:
- the immediate subfolders of the parent folder that are used for
mounting third-party repositories
- Throws:
PortalException
- if the repository or parent folder could not be
found
SystemException
- if a system exception occurred
getMountFolders
public static List<Folder> getMountFolders(long repositoryId,
long parentFolderId,
int start,
int end)
throws PortalException,
SystemException
- Returns a range of all the immediate subfolders of the parent folder that
are used for mounting third-party repositories. This method is only
supported by the Liferay repository.
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil.ALL_POS
will return the full
result set.
- Parameters:
repositoryId
- the primary key of the repositoryparentFolderId
- the primary key of the parent folderstart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)
- Returns:
- the range of immediate subfolders of the parent folder that are
used for mounting third-party repositories
- Throws:
PortalException
- if the repository or parent folder could not be
found
SystemException
- if a system exception occurred
getMountFolders
public static List<Folder> getMountFolders(long repositoryId,
long parentFolderId,
int start,
int end,
OrderByComparator obc)
throws PortalException,
SystemException
- Returns an ordered range of all the immediate subfolders of the parent
folder that are used for mounting third-party repositories. This method
is only supported by the Liferay repository.
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil.ALL_POS
will return the full
result set.
- Parameters:
repositoryId
- the primary key of the folder's repositoryparentFolderId
- the primary key of the folder's parent folderstart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)obc
- the comparator to order the folders (optionally
null
)
- Returns:
- the range of immediate subfolders of the parent folder that are
used for mounting third-party repositories ordered by comparator
obc
- Throws:
PortalException
- if the repository or parent folder could not be
found
SystemException
- if a system exception occurred
getMountFoldersCount
public static int getMountFoldersCount(long repositoryId,
long parentFolderId)
throws PortalException,
SystemException
- Returns the number of immediate subfolders of the parent folder that are
used for mounting third-party repositories. This method is only supported
by the Liferay repository.
- Parameters:
repositoryId
- the primary key of the repositoryparentFolderId
- the primary key of the parent folder
- Returns:
- the number of folders of the parent folder that are used for
mounting third-party repositories
- Throws:
PortalException
- if the repository or parent folder could not be
found
SystemException
- if a system exception occurred
getSubfolderIds
public static void getSubfolderIds(long repositoryId,
List<Long> folderIds,
long folderId)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
getSubfolderIds
public static List<Long> getSubfolderIds(long repositoryId,
long folderId)
throws PortalException,
SystemException
- Returns all the descendant folders of the folder with the primary key.
- Parameters:
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the folder
- Returns:
- the descendant folders of the folder with the primary key
- Throws:
PortalException
- if the repository or parent folder could not be
found
SystemException
- if a system exception occurred
getSubfolderIds
public static List<Long> getSubfolderIds(long repositoryId,
long folderId,
boolean recurse)
throws PortalException,
SystemException
- Returns descendant folders of the folder with the primary key, optionally
limiting to one level deep.
- Parameters:
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the folderrecurse
- whether to recurse through each subfolder
- Returns:
- the descendant folders of the folder with the primary key
- Throws:
PortalException
- if the repository or parent folder could not be
found
SystemException
- if a system exception occurred
getTempFileEntryNames
public static String[] getTempFileEntryNames(long groupId,
long folderId,
String tempFolderName)
throws PortalException,
SystemException
- Returns all the temporary file entry names.
- Parameters:
groupId
- the primary key of the groupfolderId
- the primary key of the folder where the file entry will
eventually residetempFolderName
- the temporary folder's name
- Returns:
- the temporary file entry names
- Throws:
PortalException
- if the folder was invalid
SystemException
- if a system exception occurred- See Also:
addTempFileEntry(long, long, String, String, File)
,
TempFileUtil
lockFileEntry
public static Lock lockFileEntry(long fileEntryId)
throws PortalException,
SystemException
- Deprecated.
checkOutFileEntry(long, ServiceContext)
- Throws:
PortalException
SystemException
lockFileEntry
public static Lock lockFileEntry(long fileEntryId,
String owner,
long expirationTime)
throws PortalException,
SystemException
- Deprecated.
checkOutFileEntry(long, String, long,
ServiceContext)
- Throws:
PortalException
SystemException
lockFolder
public static Lock lockFolder(long repositoryId,
long folderId)
throws PortalException,
SystemException
- Locks the folder. This method is primarily used by WebDAV.
- Parameters:
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the folder
- Returns:
- the lock object
- Throws:
PortalException
- if the repository or folder could not be found
SystemException
- if a system exception occurred
lockFolder
public static Lock lockFolder(long repositoryId,
long folderId,
String owner,
boolean inheritable,
long expirationTime)
throws PortalException,
SystemException
- Locks the folder. This method is primarily used by WebDAV.
- Parameters:
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the folderowner
- the owner string for the checkout (optionally
null
)inheritable
- whether the lock must propagate to descendantsexpirationTime
- the time in milliseconds before the lock expires.
If the value is 0
, the default expiration time will
be used from portal.properties>.
Returns:
the lock object
Throws:
PortalException
- if the repository or folder could not be found
SystemException
- if a system exception occurred
moveFileEntry
public static FileEntry moveFileEntry(long fileEntryId,
long newFolderId,
ServiceContext serviceContext)
throws PortalException,
SystemException
- Moves the file entry to the new folder.
- Parameters:
fileEntryId
- the primary key of the file entrynewFolderId
- the primary key of the new folderserviceContext
- the service context to be applied
- Returns:
- the file entry
- Throws:
PortalException
- if the file entry or the new folder could not be
found
SystemException
- if a system exception occurred
moveFolder
public static Folder moveFolder(long folderId,
long parentFolderId,
ServiceContext serviceContext)
throws PortalException,
SystemException
- Moves the folder to the new parent folder with the primary key.
- Parameters:
folderId
- the primary key of the folderparentFolderId
- the primary key of the new parent folderserviceContext
- the service context to be applied
- Returns:
- the file entry
- Throws:
PortalException
- if the folder could not be found
SystemException
- if a system exception occurred
refreshFileEntryLock
public static Lock refreshFileEntryLock(String lockUuid,
long expirationTime)
throws PortalException,
SystemException
- Refreshes the lock for the file entry. This method is primarily used by
WebDAV.
- Parameters:
lockUuid
- the lock's universally unique identifierexpirationTime
- the time in milliseconds before the lock expires.
If the value is 0
, the default expiration time will
be used from portal.properties>.
Returns:
the lock object
Throws:
PortalException
- if the file entry or lock could not be found
SystemException
- if a system exception occurred
refreshFolderLock
public static Lock refreshFolderLock(String lockUuid,
long expirationTime)
throws PortalException,
SystemException
- Refreshes the lock for the folder. This method is primarily used by
WebDAV.
- Parameters:
lockUuid
- the lock's universally unique identifierexpirationTime
- the time in milliseconds before the lock expires.
If the value is 0
, the default expiration time will
be used from portal.properties>.
Returns:
the lock object
Throws:
PortalException
- if the folder or lock could not be found
SystemException
- if a system exception occurred
revertFileEntry
public static void revertFileEntry(long fileEntryId,
String version,
ServiceContext serviceContext)
throws PortalException,
SystemException
- Reverts the file entry to a previous version. A new version will be
created based on the previous version and metadata.
- Parameters:
fileEntryId
- the primary key of the file entryversion
- the version to revert back toserviceContext
- the service context to be applied
- Throws:
PortalException
- if the file entry or version could not be found
SystemException
- if a system exception occurred
search
public static Hits search(long repositoryId,
SearchContext searchContext)
throws SearchException
- Throws:
SearchException
search
public static Hits search(long repositoryId,
SearchContext searchContext,
Query query)
throws SearchException
- Throws:
SearchException
unlockFileEntry
public static void unlockFileEntry(long fileEntryId)
throws PortalException,
SystemException
- Deprecated. Use
checkInFileEntry(long, boolean, String,
ServiceContext)
.
- Throws:
PortalException
SystemException
unlockFileEntry
public static void unlockFileEntry(long fileEntryId,
String lockUuid)
throws PortalException,
SystemException
- Deprecated. Use
checkInFileEntry(long, String)
.
- Throws:
PortalException
SystemException
unlockFolder
public static void unlockFolder(long repositoryId,
long folderId,
String lockUuid)
throws PortalException,
SystemException
- Unlocks the folder. This method is primarily used by WebDAV.
- Parameters:
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the folderlockUuid
- the lock's universally unique identifier
- Throws:
PortalException
- if the repository or folder could not be found
SystemException
- if a system exception occurred
unlockFolder
public static void unlockFolder(long repositoryId,
long parentFolderId,
String name,
String lockUuid)
throws PortalException,
SystemException
- Unlocks the folder. This method is primarily used by WebDAV.
- Parameters:
repositoryId
- the primary key of the repositoryparentFolderId
- the primary key of the parent foldername
- the folder's namelockUuid
- the lock's universally unique identifier
- Throws:
PortalException
- if the repository or folder could not be found
SystemException
- if a system exception occurred
updateFileEntry
public static FileEntry updateFileEntry(long fileEntryId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
boolean majorVersion,
byte[] bytes,
ServiceContext serviceContext)
throws PortalException,
SystemException
- Updates a file entry and associated metadata based on a byte array
object. If the file data is
null
, then only the associated
metadata (i.e., title
, description
, and
parameters in the serviceContext
) will be updated.
This method takes two file names, the sourceFileName
and the
title
. The sourceFileName
corresponds to the
name of the actual file being uploaded. The title
corresponds to a name the client wishes to assign this file after it has
been uploaded to the portal.
- Parameters:
fileEntryId
- the primary key of the file entrysourceFileName
- the original file's name (optionally
null
)mimeType
- the file's MIME type (optionally null
)title
- the new name to be assigned to the file (optionally
null
)description
- the file's new descriptionchangeLog
- the file's version change log (optionally
null
)majorVersion
- whether the new file version is a major versionbytes
- the file's data (optionally null
)serviceContext
- the service context to be applied. Can set the
asset category IDs, asset tag names, and expando bridge
attributes for the file entry. In a Liferay repository, it may
include: - fileEntryTypeId - ID for a custom file entry
type
- fieldsMap - mapping for fields associated with a
custom file entry type
- Returns:
- the file entry
- Throws:
PortalException
- if the file entry could not be found
SystemException
- if a system exception occurred
updateFileEntry
public static FileEntry updateFileEntry(long fileEntryId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
boolean majorVersion,
File file,
ServiceContext serviceContext)
throws PortalException,
SystemException
- Updates a file entry and associated metadata based on a
File
object. If the file data is null
, then only the associated
metadata (i.e., title
, description
, and
parameters in the serviceContext
) will be updated.
This method takes two file names, the sourceFileName
and the
title
. The sourceFileName
corresponds to the
name of the actual file being uploaded. The title
corresponds to a name the client wishes to assign this file after it has
been uploaded to the portal.
- Parameters:
fileEntryId
- the primary key of the file entrysourceFileName
- the original file's name (optionally
null
)mimeType
- the file's MIME type (optionally null
)title
- the new name to be assigned to the file (optionally
null
)description
- the file's new descriptionchangeLog
- the file's version change log (optionally
null
)majorVersion
- whether the new file version is a major versionfile
- EntryId the primary key of the file entryserviceContext
- the service context to be applied. Can set the
asset category IDs, asset tag names, and expando bridge
attributes for the file entry. In a Liferay repository, it may
include: - fileEntryTypeId - ID for a custom file entry
type
- fieldsMap - mapping for fields associated with a
custom file entry type
- Returns:
- the file entry
- Throws:
PortalException
- if the file entry could not be found
SystemException
- if a system exception occurred
updateFileEntry
public static FileEntry updateFileEntry(long fileEntryId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
boolean majorVersion,
InputStream is,
long size,
ServiceContext serviceContext)
throws PortalException,
SystemException
- Updates a file entry and associated metadata based on an
InputStream
object. If the file data is null
, then only the
associated metadata (i.e., title
, description
,
and parameters in the serviceContext
) will be updated.
This method takes two file names, the sourceFileName
and the
title
. The sourceFileName
corresponds to the
name of the actual file being uploaded. The title
corresponds to a name the client wishes to assign this file after it has
been uploaded to the portal.
- Parameters:
fileEntryId
- the primary key of the file entrysourceFileName
- the original file's name (optionally
null
)mimeType
- the file's MIME type (optionally null
)title
- the new name to be assigned to the file (optionally
null
)description
- the file's new descriptionchangeLog
- the file's version change log (optionally
null
)majorVersion
- whether the new file version is a major versionis
- the file's data (optionally null
)size
- the file's size (optionally 0
)serviceContext
- the service context to be applied. Can set the
asset category IDs, asset tag names, and expando bridge
attributes for the file entry. In a Liferay repository, it may
include: - fileEntryTypeId - ID for a custom file entry
type
- fieldsMap - mapping for fields associated with a
custom file entry type
- Returns:
- the file entry
- Throws:
PortalException
- if the file entry could not be found
SystemException
- if a system exception occurred
updateFileEntryAndCheckIn
public static FileEntry updateFileEntryAndCheckIn(long fileEntryId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
boolean majorVersion,
File file,
ServiceContext serviceContext)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
updateFileEntryAndCheckIn
public static FileEntry updateFileEntryAndCheckIn(long fileEntryId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
boolean majorVersion,
InputStream is,
long size,
ServiceContext serviceContext)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
updateFileShortcut
public static DLFileShortcut updateFileShortcut(long fileShortcutId,
long folderId,
long toFileEntryId,
ServiceContext serviceContext)
throws PortalException,
SystemException
- Updates a file shortcut to the existing file entry. This method is only
supported by the Liferay repository.
- Parameters:
fileShortcutId
- the primary key of the file shortcutfolderId
- the primary key of the file shortcut's parent foldertoFileEntryId
- the primary key of the file shortcut's file entryserviceContext
- the service context to be applied. Can set the
asset category IDs, asset tag names, and expando bridge
attributes for the file entry.
- Returns:
- the file shortcut
- Throws:
PortalException
- if the file shortcut, folder, or file entry could
not be found
SystemException
- if a system exception occurred
updateFolder
public static Folder updateFolder(long folderId,
String name,
String description,
ServiceContext serviceContext)
throws PortalException,
SystemException
- Updates the folder.
- Parameters:
folderId
- the primary key of the foldername
- the folder's new namedescription
- the folder's new descriptionserviceContext
- the service context to be applied. In a Liferay
repository, it may include: - defaultFileEntryTypeId -
the file entry type to default all Liferay file entries to
- dlFileEntryTypesSearchContainerPrimaryKeys - a
comma-delimited list of file entry type primary keys allowed in
the given folder and all descendants
-
overrideFileEntryTypes - boolean specifying whether to override
ancestral folder's restriction of file entry types allowed
- workflowDefinitionXYZ - the workflow definition name
specified per file entry type. The parameter name must be the
string
workflowDefinition
appended by the
fileEntryTypeId
(optionally 0
).
- Returns:
- the folder
- Throws:
PortalException
- if the current or new parent folder could not be
found or if the new parent folder's information was invalid
SystemException
- if a system exception occurred
verifyFileEntryCheckOut
public static boolean verifyFileEntryCheckOut(long repositoryId,
long fileEntryId,
String lockUuid)
throws PortalException,
SystemException
- Returns
true
if the file entry is checked out. This method
is primarily used by WebDAV.
- Parameters:
repositoryId
- the primary key for the repositoryfileEntryId
- the primary key for the file entrylockUuid
- the lock's universally unique identifier
- Returns:
true
if the file entry is checked out;
false
otherwise
- Throws:
PortalException
- if the file entry could not be found
SystemException
- if a system exception occurred
verifyFileEntryLock
public static boolean verifyFileEntryLock(long repositoryId,
long fileEntryId,
String lockUuid)
throws PortalException,
SystemException
- Throws:
PortalException
SystemException
verifyInheritableLock
public static boolean verifyInheritableLock(long repositoryId,
long folderId,
String lockUuid)
throws PortalException,
SystemException
- Returns
true
if the inheritable lock exists. This method is
primarily used by WebDAV.
- Parameters:
repositoryId
- the primary key for the repositoryfolderId
- the primary key for the folderlockUuid
- the lock's universally unique identifier
- Returns:
true
if the inheritable lock exists;
false
otherwise
- Throws:
PortalException
- if the folder could not be found
SystemException
- if a system exception occurred
getService
public static DLAppService getService()
setService
public void setService(DLAppService service)
- Deprecated.
Overview
Package
Class
Use
Tree
Deprecated
Index
Help
Liferay 6.1.2-ce-ga3
PREV CLASS
NEXT CLASS
FRAMES
NO FRAMES
All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD
DETAIL: FIELD | CONSTR | METHOD