@ProviderType
public class DLAppServiceUtil
extends java.lang.Object
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. 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 and Description |
|---|
DLAppServiceUtil() |
| Modifier and Type | Method and Description |
|---|---|
static FileEntry |
addFileEntry(long repositoryId,
long folderId,
java.lang.String sourceFileName,
java.lang.String mimeType,
java.lang.String title,
java.lang.String description,
java.lang.String changeLog,
byte[] bytes,
ServiceContext serviceContext)
Adds a file entry and associated metadata.
|
static FileEntry |
addFileEntry(long repositoryId,
long folderId,
java.lang.String sourceFileName,
java.lang.String mimeType,
java.lang.String title,
java.lang.String description,
java.lang.String changeLog,
java.io.File file,
ServiceContext serviceContext)
Adds a file entry and associated metadata.
|
static FileEntry |
addFileEntry(long repositoryId,
long folderId,
java.lang.String sourceFileName,
java.lang.String mimeType,
java.lang.String title,
java.lang.String description,
java.lang.String changeLog,
java.io.InputStream is,
long size,
ServiceContext serviceContext)
Adds a file entry and associated metadata.
|
static FileShortcut |
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,
java.lang.String name,
java.lang.String description,
ServiceContext serviceContext)
Adds a folder.
|
static FileEntry |
addTempFileEntry(long groupId,
long folderId,
java.lang.String folderName,
java.lang.String fileName,
java.io.File file,
java.lang.String mimeType)
Adds a temporary file entry.
|
static FileEntry |
addTempFileEntry(long groupId,
long folderId,
java.lang.String folderName,
java.lang.String fileName,
java.io.InputStream inputStream,
java.lang.String mimeType)
Adds a temporary file entry.
|
static void |
cancelCheckOut(long fileEntryId)
Cancels the check out of the file entry.
|
static void |
checkInFileEntry(long fileEntryId,
boolean majorVersion,
java.lang.String changeLog,
ServiceContext serviceContext)
Checks in the file entry.
|
static void |
checkInFileEntry(long fileEntryId,
java.lang.String lockUuid)
Deprecated.
As of 6.2.0, replaced by
checkInFileEntry(long,
String, ServiceContext) |
static void |
checkInFileEntry(long fileEntryId,
java.lang.String lockUuid,
ServiceContext serviceContext)
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,
java.lang.String owner,
long expirationTime,
ServiceContext serviceContext)
Checks out the file entry.
|
static Folder |
copyFolder(long repositoryId,
long sourceFolderId,
long parentFolderId,
java.lang.String name,
java.lang.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,
java.lang.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,
java.lang.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,
java.lang.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,
java.lang.String folderName,
java.lang.String fileName)
Deletes the temporary file entry.
|
static java.lang.String |
getBeanIdentifier()
Returns the Spring bean ID for this bean.
|
static java.util.List<FileEntry> |
getFileEntries(long repositoryId,
long folderId)
Returns all the file entries in the folder.
|
static java.util.List<FileEntry> |
getFileEntries(long repositoryId,
long folderId,
int start,
int end)
Returns a name-ordered range of all the file entries in the folder.
|
static java.util.List<FileEntry> |
getFileEntries(long repositoryId,
long folderId,
int start,
int end,
OrderByComparator<FileEntry> obc)
Returns an ordered range of all the file entries in the folder.
|
static java.util.List<FileEntry> |
getFileEntries(long repositoryId,
long folderId,
long fileEntryTypeId)
Returns the file entries with the file entry type in the folder.
|
static java.util.List<FileEntry> |
getFileEntries(long repositoryId,
long folderId,
long fileEntryTypeId,
int start,
int end)
Returns a name-ordered range of all the file entries with the file entry
type in the folder.
|
static java.util.List<FileEntry> |
getFileEntries(long repositoryId,
long folderId,
long fileEntryTypeId,
int start,
int end,
OrderByComparator<FileEntry> obc)
Returns an ordered range of all the file entries with the file entry type
in the folder.
|
static java.util.List<FileEntry> |
getFileEntries(long repositoryId,
long folderId,
java.lang.String[] mimeTypes) |
static java.util.List<FileEntry> |
getFileEntries(long repositoryId,
long folderId,
java.lang.String[] mimeTypes,
int start,
int end,
OrderByComparator<FileEntry> obc) |
static java.util.List<java.lang.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,
java.lang.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 int |
getFileEntriesCount(long repositoryId,
long folderId,
java.lang.String[] mimeTypes) |
static FileEntry |
getFileEntry(long fileEntryId)
Returns the file entry with the primary key.
|
static FileEntry |
getFileEntry(long groupId,
long folderId,
java.lang.String title)
Returns the file entry with the title in the folder.
|
static FileEntry |
getFileEntryByUuidAndGroupId(java.lang.String uuid,
long groupId)
Returns the file entry with the UUID and group.
|
static FileShortcut |
getFileShortcut(long fileShortcutId)
Returns the file shortcut with the primary key.
|
static FileVersion |
getFileVersion(long fileVersionId)
Returns the file version with the primary key.
|
static Folder |
getFolder(long folderId)
Returns the folder with the primary key.
|
static Folder |
getFolder(long repositoryId,
long parentFolderId,
java.lang.String name)
Returns the folder with the name in the parent folder.
|
static java.util.List<Folder> |
getFolders(long repositoryId,
long parentFolderId)
Returns all immediate subfolders of the parent folder.
|
static java.util.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 java.util.List<Folder> |
getFolders(long repositoryId,
long parentFolderId,
boolean includeMountFolders,
int start,
int end)
Returns a name-ordered range of all the immediate subfolders of the
parent folder, optionally including mount folders for third-party
repositories.
|
static java.util.List<Folder> |
getFolders(long repositoryId,
long parentFolderId,
boolean includeMountFolders,
int start,
int end,
OrderByComparator<Folder> obc)
Returns an ordered range of all the immediate subfolders of the parent
folder.
|
static java.util.List<Folder> |
getFolders(long repositoryId,
long parentFolderId,
int status,
boolean includeMountFolders,
int start,
int end,
OrderByComparator<Folder> obc)
Returns an ordered range of all the immediate subfolders of the parent
folder.
|
static java.util.List<Folder> |
getFolders(long repositoryId,
long parentFolderId,
int start,
int end)
Returns a name-ordered range of all the immediate subfolders of the
parent folder.
|
static java.util.List<Folder> |
getFolders(long repositoryId,
long parentFolderId,
int start,
int end,
OrderByComparator<Folder> obc)
Returns an ordered range of all the immediate subfolders of the parent
folder.
|
static java.util.List<java.lang.Object> |
getFoldersAndFileEntriesAndFileShortcuts(long repositoryId,
long folderId,
int status,
boolean includeMountFolders,
int start,
int end)
Returns a name-ordered range of all the immediate subfolders, file
entries, and file shortcuts in the parent folder.
|
static java.util.List<java.lang.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 java.util.List<java.lang.Object> |
getFoldersAndFileEntriesAndFileShortcuts(long repositoryId,
long folderId,
int status,
java.lang.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,
java.lang.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 |
getFoldersCount(long repositoryId,
long parentFolderId,
int status,
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,
java.util.List<java.lang.Long> folderIds,
int status)
Returns the number of immediate subfolders and file entries across the
folders.
|
static java.util.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 java.util.List<FileEntry> |
getGroupFileEntries(long groupId,
long userId,
int start,
int end,
OrderByComparator<FileEntry> obc)
Returns an ordered range of all the file entries in the group that are
stored within the Liferay repository.
|
static java.util.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 java.util.List<FileEntry> |
getGroupFileEntries(long groupId,
long userId,
long rootFolderId,
int start,
int end,
OrderByComparator<FileEntry> 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 java.util.List<FileEntry> |
getGroupFileEntries(long groupId,
long userId,
long rootFolderId,
java.lang.String[] mimeTypes,
int status,
int start,
int end,
OrderByComparator<FileEntry> 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,
java.lang.String[] mimeTypes,
int status) |
static java.util.List<Folder> |
getMountFolders(long repositoryId,
long parentFolderId)
Returns all immediate subfolders of the parent folder that are used for
mounting third-party repositories.
|
static java.util.List<Folder> |
getMountFolders(long repositoryId,
long parentFolderId,
int start,
int end)
Returns a name-ordered range of all the immediate subfolders of the
parent folder that are used for mounting third-party repositories.
|
static java.util.List<Folder> |
getMountFolders(long repositoryId,
long parentFolderId,
int start,
int end,
OrderByComparator<Folder> 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,
java.util.List<java.lang.Long> folderIds,
long folderId) |
static java.util.List<java.lang.Long> |
getSubfolderIds(long repositoryId,
long folderId)
Returns all the descendant folders of the folder with the primary key.
|
static java.util.List<java.lang.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 java.lang.String[] |
getTempFileNames(long groupId,
long folderId,
java.lang.String folderName)
Returns all the temporary file entry names.
|
static Lock |
lockFolder(long repositoryId,
long folderId)
Locks the folder.
|
static Lock |
lockFolder(long repositoryId,
long folderId,
java.lang.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 FileEntry |
moveFileEntryFromTrash(long fileEntryId,
long newFolderId,
ServiceContext serviceContext)
Moves the file entry from a trashed folder to the new folder.
|
static FileEntry |
moveFileEntryToTrash(long fileEntryId)
Moves the file entry with the primary key to the trash portlet.
|
static FileShortcut |
moveFileShortcutFromTrash(long fileShortcutId,
long newFolderId,
ServiceContext serviceContext)
Moves the file shortcut from a trashed folder to the new folder.
|
static FileShortcut |
moveFileShortcutToTrash(long fileShortcutId)
Moves the file shortcut with the primary key to the trash portlet.
|
static Folder |
moveFolder(long folderId,
long parentFolderId,
ServiceContext serviceContext)
Moves the folder to the new parent folder with the primary key.
|
static Folder |
moveFolderFromTrash(long folderId,
long parentFolderId,
ServiceContext serviceContext)
Moves the folder with the primary key from the trash portlet to the new
parent folder with the primary key.
|
static Folder |
moveFolderToTrash(long folderId)
Moves the folder with the primary key to the trash portlet.
|
static Lock |
refreshFileEntryLock(java.lang.String lockUuid,
long companyId,
long expirationTime)
Refreshes the lock for the file entry.
|
static Lock |
refreshFolderLock(java.lang.String lockUuid,
long companyId,
long expirationTime)
Refreshes the lock for the folder.
|
static void |
restoreFileEntryFromTrash(long fileEntryId)
Restores the file entry with the primary key from the trash portlet.
|
static void |
restoreFileShortcutFromTrash(long fileShortcutId)
Restores the file shortcut with the primary key from the trash portlet.
|
static void |
restoreFolderFromTrash(long folderId)
Restores the folder with the primary key from the trash portlet.
|
static void |
revertFileEntry(long fileEntryId,
java.lang.String version,
ServiceContext serviceContext)
Reverts the file entry to a previous version.
|
static Hits |
search(long repositoryId,
long creatorUserId,
int status,
int start,
int end) |
static Hits |
search(long repositoryId,
long creatorUserId,
long folderId,
java.lang.String[] mimeTypes,
int status,
int start,
int end) |
static Hits |
search(long repositoryId,
SearchContext searchContext) |
static Hits |
search(long repositoryId,
SearchContext searchContext,
Query query) |
static void |
setBeanIdentifier(java.lang.String beanIdentifier)
Sets the Spring bean ID for this bean.
|
void |
setService(DLAppService service)
Deprecated.
As of 6.2.0
|
static void |
subscribeFileEntryType(long groupId,
long fileEntryTypeId)
Subscribe the user to changes in documents of the file entry type.
|
static void |
subscribeFolder(long groupId,
long folderId)
Subscribe the user to document changes in the folder.
|
static void |
unlockFileEntry(long fileEntryId)
Deprecated.
As of 6.2.0, replaced by
checkInFileEntry(long,
boolean, String, ServiceContext). |
static void |
unlockFileEntry(long fileEntryId,
java.lang.String lockUuid)
Deprecated.
As of 6.2.0, replaced by
checkInFileEntry(long,
String). |
static void |
unlockFolder(long repositoryId,
long folderId,
java.lang.String lockUuid)
Unlocks the folder.
|
static void |
unlockFolder(long repositoryId,
long parentFolderId,
java.lang.String name,
java.lang.String lockUuid)
Unlocks the folder.
|
static void |
unsubscribeFileEntryType(long groupId,
long fileEntryTypeId)
Unsubscribe the user from changes in documents of the file entry type.
|
static void |
unsubscribeFolder(long groupId,
long folderId)
Unsubscribe the user from document changes in the folder.
|
static FileEntry |
updateFileEntry(long fileEntryId,
java.lang.String sourceFileName,
java.lang.String mimeType,
java.lang.String title,
java.lang.String description,
java.lang.String changeLog,
boolean majorVersion,
byte[] bytes,
ServiceContext serviceContext)
Updates a file entry and associated metadata based on a byte array
object.
|
static FileEntry |
updateFileEntry(long fileEntryId,
java.lang.String sourceFileName,
java.lang.String mimeType,
java.lang.String title,
java.lang.String description,
java.lang.String changeLog,
boolean majorVersion,
java.io.File file,
ServiceContext serviceContext)
Updates a file entry and associated metadata based on a
File
object. |
static FileEntry |
updateFileEntry(long fileEntryId,
java.lang.String sourceFileName,
java.lang.String mimeType,
java.lang.String title,
java.lang.String description,
java.lang.String changeLog,
boolean majorVersion,
java.io.InputStream is,
long size,
ServiceContext serviceContext)
Updates a file entry and associated metadata based on an
InputStream object. |
static FileEntry |
updateFileEntryAndCheckIn(long fileEntryId,
java.lang.String sourceFileName,
java.lang.String mimeType,
java.lang.String title,
java.lang.String description,
java.lang.String changeLog,
boolean majorVersion,
java.io.File file,
ServiceContext serviceContext) |
static FileEntry |
updateFileEntryAndCheckIn(long fileEntryId,
java.lang.String sourceFileName,
java.lang.String mimeType,
java.lang.String title,
java.lang.String description,
java.lang.String changeLog,
boolean majorVersion,
java.io.InputStream is,
long size,
ServiceContext serviceContext) |
static FileShortcut |
updateFileShortcut(long fileShortcutId,
long folderId,
long toFileEntryId,
ServiceContext serviceContext)
Updates a file shortcut to the existing file entry.
|
static Folder |
updateFolder(long folderId,
java.lang.String name,
java.lang.String description,
ServiceContext serviceContext)
Updates the folder.
|
static boolean |
verifyFileEntryCheckOut(long repositoryId,
long fileEntryId,
java.lang.String lockUuid)
Returns
true if the file entry is checked out. |
static boolean |
verifyFileEntryLock(long repositoryId,
long fileEntryId,
java.lang.String lockUuid) |
static boolean |
verifyInheritableLock(long repositoryId,
long folderId,
java.lang.String lockUuid)
Returns
true if the inheritable lock exists. |
public static FileEntry addFileEntry(long repositoryId, long folderId, java.lang.String sourceFileName, java.lang.String mimeType, java.lang.String title, java.lang.String description, java.lang.String changeLog, byte[] bytes, ServiceContext serviceContext) throws PortalException
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 invalidpublic static FileEntry addFileEntry(long repositoryId, long folderId, java.lang.String sourceFileName, java.lang.String mimeType, java.lang.String title, java.lang.String description, java.lang.String changeLog, java.io.File file, ServiceContext serviceContext) throws PortalException
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 invalidpublic static FileEntry addFileEntry(long repositoryId, long folderId, java.lang.String sourceFileName, java.lang.String mimeType, java.lang.String title, java.lang.String description, java.lang.String changeLog, java.io.InputStream is, long size, ServiceContext serviceContext) throws PortalException
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 invalidpublic static FileShortcut addFileShortcut(long repositoryId, long folderId, long toFileEntryId, ServiceContext serviceContext) throws PortalException
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 invalidpublic static Folder addFolder(long repositoryId, long parentFolderId, java.lang.String name, java.lang.String description, ServiceContext serviceContext) throws PortalException
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 repositoryPortalException - if the parent folder could not be found or if the
new folder's information was invalidpublic static FileEntry addTempFileEntry(long groupId, long folderId, java.lang.String folderName, java.lang.String fileName, java.io.File file, java.lang.String mimeType) throws PortalException
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 residefolderName - the temporary folder's namefileName - the file's original namefile - the file's data (optionally null)mimeType - the file's MIME typePortalException - if the file name was invalidTempFileEntryUtilpublic static FileEntry addTempFileEntry(long groupId, long folderId, java.lang.String folderName, java.lang.String fileName, java.io.InputStream inputStream, java.lang.String mimeType) throws PortalException
InputStream object.
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 residefolderName - the temporary folder's namefileName - the file's original nameinputStream - the file's datamimeType - the file's MIME typePortalException - if the file name was invalid or if a portal
exception occurredTempFileEntryUtilpublic static void cancelCheckOut(long fileEntryId)
throws PortalException
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
checkoutPortalException - if the file entry could not be foundcheckInFileEntry(long, boolean, String, ServiceContext),
checkOutFileEntry(long, ServiceContext)@Deprecated
public static void checkInFileEntry(long fileEntryId,
java.lang.String lockUuid)
throws PortalException
checkInFileEntry(long,
String, ServiceContext)PortalExceptionpublic static void checkInFileEntry(long fileEntryId,
java.lang.String lockUuid,
ServiceContext serviceContext)
throws PortalException
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 UUIDserviceContext - the service context to be appliedPortalException - if the file entry could not be foundcancelCheckOut(long),
checkOutFileEntry(long, String, long, ServiceContext)public static void checkInFileEntry(long fileEntryId,
boolean majorVersion,
java.lang.String changeLog,
ServiceContext serviceContext)
throws PortalException
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 appliedPortalException - if the file entry could not be foundcancelCheckOut(long),
checkOutFileEntry(long, ServiceContext)public static FileEntry checkOutFileEntry(long fileEntryId, java.lang.String owner, long expirationTime, ServiceContext serviceContext) throws PortalException
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 appliedPortalException - if the file entry could not be foundcancelCheckOut(long),
checkInFileEntry(long, String)public static void checkOutFileEntry(long fileEntryId,
ServiceContext serviceContext)
throws PortalException
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 appliedPortalException - if the file entry could not be foundcancelCheckOut(long),
checkInFileEntry(long, boolean, String, ServiceContext)public static Folder copyFolder(long repositoryId, long sourceFolderId, long parentFolderId, java.lang.String name, java.lang.String description, ServiceContext serviceContext) throws PortalException
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 appliedPortalException - if the source folder or the new parent folder
could not be found or if the new folder's information was invalidpublic static void deleteFileEntry(long fileEntryId)
throws PortalException
fileEntryId - the primary key of the file entryPortalException - if the file entry could not be foundpublic static void deleteFileEntryByTitle(long repositoryId,
long folderId,
java.lang.String title)
throws PortalException
repositoryId - the primary key of the repositoryfolderId - the primary key of the file entry's parent foldertitle - the file entry's titlePortalException - if the file entry could not be foundpublic static void deleteFileShortcut(long fileShortcutId)
throws PortalException
fileShortcutId - the primary key of the file shortcutPortalException - if the file shortcut could not be foundpublic static void deleteFileVersion(long fileEntryId,
java.lang.String version)
throws PortalException
fileEntryId - the primary key of the file entryversion - the version label of the file versionPortalException - if the file version could not be found or invalidpublic static void deleteFolder(long folderId)
throws PortalException
folderId - the primary key of the folderPortalException - if the folder could not be foundpublic static void deleteFolder(long repositoryId,
long parentFolderId,
java.lang.String name)
throws PortalException
repositoryId - the primary key of the repositoryparentFolderId - the primary key of the folder's parent foldername - the folder's namePortalException - if the folder could not be foundpublic static void deleteTempFileEntry(long groupId,
long folderId,
java.lang.String folderName,
java.lang.String fileName)
throws PortalException
groupId - the primary key of the groupfolderId - the primary key of the folder where the file entry was
eventually to residefolderName - the temporary folder's namefileName - the file's original namePortalException - if the file name was invalidTempFileEntryUtilpublic static java.lang.String getBeanIdentifier()
public static java.util.List<FileEntry> getFileEntries(long repositoryId, long folderId) throws PortalException
repositoryId - the primary key of the file entry's repositoryfolderId - the primary key of the file entry's folderPortalException - if the folder could not be foundpublic static java.util.List<FileEntry> getFileEntries(long repositoryId, long folderId, long fileEntryTypeId) throws PortalException
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 typePortalException - if the folder could not be foundpublic static java.util.List<FileEntry> getFileEntries(long repositoryId, long folderId, long fileEntryTypeId, int start, int end) throws PortalException
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)PortalException - if the folder could not be foundpublic static java.util.List<FileEntry> getFileEntries(long repositoryId, long folderId, long fileEntryTypeId, int start, int end, OrderByComparator<FileEntry> obc) throws PortalException
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)nullPortalException - if the folder could not be foundpublic static java.util.List<FileEntry> getFileEntries(long repositoryId, long folderId, java.lang.String[] mimeTypes) throws PortalException
PortalExceptionpublic static java.util.List<FileEntry> getFileEntries(long repositoryId, long folderId, java.lang.String[] mimeTypes, int start, int end, OrderByComparator<FileEntry> obc) throws PortalException
PortalExceptionpublic static java.util.List<FileEntry> getFileEntries(long repositoryId, long folderId, int start, int end) throws PortalException
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.
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)PortalException - if the folder could not be foundpublic static java.util.List<FileEntry> getFileEntries(long repositoryId, long folderId, int start, int end, OrderByComparator<FileEntry> obc) throws PortalException
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.
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)obcPortalException - if the folder could not be foundpublic static java.util.List<java.lang.Object> getFileEntriesAndFileShortcuts(long repositoryId,
long folderId,
int status,
int start,
int end)
throws PortalException
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.
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)PortalException - if the folder could not be foundpublic static int getFileEntriesAndFileShortcutsCount(long repositoryId,
long folderId,
int status)
throws PortalException
repositoryId - the primary key of the repositoryfolderId - the primary key of the folderstatus - the workflow statusPortalException - if the folder ould not be foundpublic static int getFileEntriesAndFileShortcutsCount(long repositoryId,
long folderId,
int status,
java.lang.String[] mimeTypes)
throws PortalException
repositoryId - the primary key of the repositoryfolderId - the primary key of the folderstatus - the workflow statusmimeTypes - allowed media typesPortalException - if the folder ould not be foundpublic static int getFileEntriesCount(long repositoryId,
long folderId)
throws PortalException
repositoryId - the primary key of the file entry's repositoryfolderId - the primary key of the file entry's folderPortalException - if the folder could not be foundpublic static int getFileEntriesCount(long repositoryId,
long folderId,
long fileEntryTypeId)
throws PortalException
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 typePortalException - if the folder could not be foundpublic static int getFileEntriesCount(long repositoryId,
long folderId,
java.lang.String[] mimeTypes)
throws PortalException
PortalExceptionpublic static FileEntry getFileEntry(long fileEntryId) throws PortalException
fileEntryId - the primary key of the file entryPortalException - if the file entry could not be foundpublic static FileEntry getFileEntry(long groupId, long folderId, java.lang.String title) throws PortalException
groupId - the primary key of the file entry's groupfolderId - the primary key of the file entry's foldertitle - the file entry's titlePortalException - if the file entry could not be foundpublic static FileEntry getFileEntryByUuidAndGroupId(java.lang.String uuid, long groupId) throws PortalException
uuid - the file entry's UUIDgroupId - the primary key of the file entry's groupPortalException - if the file entry could not be foundpublic static FileShortcut getFileShortcut(long fileShortcutId) throws PortalException
fileShortcutId - the primary key of the file shortcutPortalException - if the file shortcut could not be foundpublic static FileVersion getFileVersion(long fileVersionId) throws PortalException
fileVersionId - the primary key of the file versionPortalException - if the file version could not be foundpublic static Folder getFolder(long folderId) throws PortalException
folderId - the primary key of the folderPortalException - if the folder could not be foundpublic static Folder getFolder(long repositoryId, long parentFolderId, java.lang.String name) throws PortalException
repositoryId - the primary key of the folder's repositoryparentFolderId - the primary key of the folder's parent foldername - the folder's namePortalException - if the folder could not be foundpublic static java.util.List<Folder> getFolders(long repositoryId, long parentFolderId) throws PortalException
repositoryId - the primary key of the folder's repositoryparentFolderId - the primary key of the folder's parent folderPortalException - if the parent folder could not be foundpublic static java.util.List<Folder> getFolders(long repositoryId, long parentFolderId, boolean includeMountFolders) throws PortalException
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 repositoriesPortalException - if the parent folder could not be foundpublic static java.util.List<Folder> getFolders(long repositoryId, long parentFolderId, boolean includeMountFolders, int start, int end) throws PortalException
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.
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)PortalException - if the parent folder could not be foundpublic static java.util.List<Folder> getFolders(long repositoryId, long parentFolderId, boolean includeMountFolders, int start, int end, OrderByComparator<Folder> obc) throws PortalException
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.
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)obcPortalException - if the parent folder could not be foundpublic static java.util.List<Folder> getFolders(long repositoryId, long parentFolderId, int start, int end) throws PortalException
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.
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)PortalException - if the parent folder could not be foundpublic static java.util.List<Folder> getFolders(long repositoryId, long parentFolderId, int start, int end, OrderByComparator<Folder> obc) throws PortalException
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.
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)obcPortalException - if the parent folder could not be foundpublic static java.util.List<Folder> getFolders(long repositoryId, long parentFolderId, int status, boolean includeMountFolders, int start, int end, OrderByComparator<Folder> obc) throws PortalException
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.
repositoryId - the primary key of the folder's repositoryparentFolderId - the primary key of the folder's 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 folders (optionally
null)obcPortalException - if the parent folder could not be foundpublic static java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(long repositoryId,
long folderId,
int status,
boolean includeMountFolders,
int start,
int end)
throws PortalException
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.
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)PortalException - if the parent folder could not be foundpublic static java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(long repositoryId,
long folderId,
int status,
boolean includeMountFolders,
int start,
int end,
OrderByComparator<?> obc)
throws PortalException
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.
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)obcPortalException - if the parent folder could not be foundpublic static java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(long repositoryId,
long folderId,
int status,
java.lang.String[] mimeTypes,
boolean includeMountFolders,
int start,
int end,
OrderByComparator<?> obc)
throws PortalException
PortalExceptionpublic static int getFoldersAndFileEntriesAndFileShortcutsCount(long repositoryId,
long folderId,
int status,
boolean includeMountFolders)
throws PortalException
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 repositoriesPortalException - if the folder could not be foundpublic static int getFoldersAndFileEntriesAndFileShortcutsCount(long repositoryId,
long folderId,
int status,
java.lang.String[] mimeTypes,
boolean includeMountFolders)
throws PortalException
PortalExceptionpublic static int getFoldersCount(long repositoryId,
long parentFolderId)
throws PortalException
repositoryId - the primary key of the folder's repositoryparentFolderId - the primary key of the folder's parent folderPortalException - if the parent folder could not be foundpublic static int getFoldersCount(long repositoryId,
long parentFolderId,
boolean includeMountFolders)
throws PortalException
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 repositoriesPortalException - if the parent folder could not be foundpublic static int getFoldersCount(long repositoryId,
long parentFolderId,
int status,
boolean includeMountFolders)
throws PortalException
repositoryId - the primary key of the folder's repositoryparentFolderId - the primary key of the folder's parent folderstatus - the workflow statusincludeMountFolders - whether to include mount folders for
third-party repositoriesPortalException - if the parent folder could not be foundpublic static int getFoldersFileEntriesCount(long repositoryId,
java.util.List<java.lang.Long> folderIds,
int status)
throws PortalException
repositoryId - the primary key of the repositoryfolderIds - the primary keys of folders from which to count
immediate subfolders and file entriesstatus - the workflow statusPortalException - if the repository could not be foundpublic static java.util.List<FileEntry> getGroupFileEntries(long groupId, long userId, long rootFolderId, java.lang.String[] mimeTypes, int status, int start, int end, OrderByComparator<FileEntry> obc) throws PortalException
PortalExceptionpublic static java.util.List<FileEntry> getGroupFileEntries(long groupId, long userId, long rootFolderId, int start, int end) throws PortalException
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.
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)PortalException - if the group could not be foundpublic static java.util.List<FileEntry> getGroupFileEntries(long groupId, long userId, long rootFolderId, int start, int end, OrderByComparator<FileEntry> obc) throws PortalException
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.
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)obcPortalException - if the group could not be foundpublic static java.util.List<FileEntry> getGroupFileEntries(long groupId, long userId, int start, int end) throws PortalException
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.
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)PortalException - if the group could not be foundpublic static java.util.List<FileEntry> getGroupFileEntries(long groupId, long userId, int start, int end, OrderByComparator<FileEntry> obc) throws PortalException
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.
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)obcPortalException - if the group could not be foundpublic static int getGroupFileEntriesCount(long groupId,
long userId)
throws PortalException
groupId - the primary key of the groupuserId - the primary key of the user who created the file
(optionally 0)PortalException - if the group could not be foundpublic static int getGroupFileEntriesCount(long groupId,
long userId,
long rootFolderId)
throws PortalException
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
searchPortalException - if the group could not be foundpublic static int getGroupFileEntriesCount(long groupId,
long userId,
long rootFolderId,
java.lang.String[] mimeTypes,
int status)
throws PortalException
PortalExceptionpublic static java.util.List<Folder> getMountFolders(long repositoryId, long parentFolderId) throws PortalException
repositoryId - the primary key of the folder's repositoryparentFolderId - the primary key of the folder's parent folderPortalException - if the repository or parent folder could not be
foundpublic static java.util.List<Folder> getMountFolders(long repositoryId, long parentFolderId, int start, int end) throws PortalException
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.
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)PortalException - if the repository or parent folder could not be
foundpublic static java.util.List<Folder> getMountFolders(long repositoryId, long parentFolderId, int start, int end, OrderByComparator<Folder> obc) throws PortalException
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.
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)obcPortalException - if the repository or parent folder could not be
foundpublic static int getMountFoldersCount(long repositoryId,
long parentFolderId)
throws PortalException
repositoryId - the primary key of the repositoryparentFolderId - the primary key of the parent folderPortalException - if the repository or parent folder could not be
foundpublic static java.util.List<java.lang.Long> getSubfolderIds(long repositoryId,
long folderId)
throws PortalException
repositoryId - the primary key of the repositoryfolderId - the primary key of the folderPortalException - if the repository or parent folder could not be
foundpublic static java.util.List<java.lang.Long> getSubfolderIds(long repositoryId,
long folderId,
boolean recurse)
throws PortalException
repositoryId - the primary key of the repositoryfolderId - the primary key of the folderrecurse - whether to recurse through each subfolderPortalException - if the repository or parent folder could not be
foundpublic static void getSubfolderIds(long repositoryId,
java.util.List<java.lang.Long> folderIds,
long folderId)
throws PortalException
PortalExceptionpublic static java.lang.String[] getTempFileNames(long groupId,
long folderId,
java.lang.String folderName)
throws PortalException
groupId - the primary key of the groupfolderId - the primary key of the folder where the file entry will
eventually residefolderName - the temporary folder's namePortalException - if the folder was invalidaddTempFileEntry(long, long, String, String, File, String),
TempFileEntryUtilpublic static Lock lockFolder(long repositoryId, long folderId) throws PortalException
repositoryId - the primary key of the repositoryfolderId - the primary key of the folderPortalException - if the repository or folder could not be foundpublic static Lock lockFolder(long repositoryId, long folderId, java.lang.String owner, boolean inheritable, long expirationTime) throws PortalException
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>.PortalException - if the repository or folder could not be foundpublic static FileEntry moveFileEntry(long fileEntryId, long newFolderId, ServiceContext serviceContext) throws PortalException
fileEntryId - the primary key of the file entrynewFolderId - the primary key of the new folderserviceContext - the service context to be appliedPortalException - if the file entry or the new folder could not be
foundpublic static FileEntry moveFileEntryFromTrash(long fileEntryId, long newFolderId, ServiceContext serviceContext) throws PortalException
fileEntryId - the primary key of the file entrynewFolderId - the primary key of the new folderserviceContext - the service context to be appliedPortalException - if the file entry or the new folder could not be
foundpublic static FileEntry moveFileEntryToTrash(long fileEntryId) throws PortalException
fileEntryId - the primary key of the file entryPortalException - if the file entry could not be foundpublic static FileShortcut moveFileShortcutFromTrash(long fileShortcutId, long newFolderId, ServiceContext serviceContext) throws PortalException
fileShortcutId - the primary key of the file shortcutnewFolderId - the primary key of the new folderserviceContext - the service context to be appliedPortalException - if the file entry or the new folder could not be
foundpublic static FileShortcut moveFileShortcutToTrash(long fileShortcutId) throws PortalException
fileShortcutId - the primary key of the file shortcutPortalException - if the file shortcut could not be foundpublic static Folder moveFolder(long folderId, long parentFolderId, ServiceContext serviceContext) throws PortalException
folderId - the primary key of the folderparentFolderId - the primary key of the new parent folderserviceContext - the service context to be appliedPortalException - if the folder could not be foundpublic static Folder moveFolderFromTrash(long folderId, long parentFolderId, ServiceContext serviceContext) throws PortalException
folderId - the primary key of the folderparentFolderId - the primary key of the new parent folderserviceContext - the service context to be appliedPortalException - if the folder could not be foundpublic static Folder moveFolderToTrash(long folderId) throws PortalException
folderId - the primary key of the folderPortalException - if the folder could not be foundpublic static Lock refreshFileEntryLock(java.lang.String lockUuid, long companyId, long expirationTime) throws PortalException
lockUuid - the lock's UUIDcompanyId - the primary key of the file entry's companyexpirationTime - the time in milliseconds before the lock expires.
If the value is 0, the default expiration time will
be used from portal.properties>.PortalException - if the file entry or lock could not be foundpublic static Lock refreshFolderLock(java.lang.String lockUuid, long companyId, long expirationTime) throws PortalException
lockUuid - the lock's UUIDcompanyId - the primary key of the file entry's companyexpirationTime - the time in milliseconds before the lock expires.
If the value is 0, the default expiration time will
be used from portal.properties>.PortalException - if the folder or lock could not be foundpublic static void restoreFileEntryFromTrash(long fileEntryId)
throws PortalException
fileEntryId - the primary key of the file entryPortalException - if the file entry could not be foundpublic static void restoreFileShortcutFromTrash(long fileShortcutId)
throws PortalException
fileShortcutId - the primary key of the file shortcutPortalException - if the file shortcut could not be foundpublic static void restoreFolderFromTrash(long folderId)
throws PortalException
folderId - the primary key of the folderPortalException - if the folder could not be foundpublic static void revertFileEntry(long fileEntryId,
java.lang.String version,
ServiceContext serviceContext)
throws PortalException
fileEntryId - the primary key of the file entryversion - the version to revert back toserviceContext - the service context to be appliedPortalException - if the file entry or version could not be foundpublic static Hits search(long repositoryId, long creatorUserId, long folderId, java.lang.String[] mimeTypes, int status, int start, int end) throws PortalException
PortalExceptionpublic static Hits search(long repositoryId, long creatorUserId, int status, int start, int end) throws PortalException
PortalExceptionpublic static Hits search(long repositoryId, SearchContext searchContext) throws SearchException
SearchExceptionpublic static Hits search(long repositoryId, SearchContext searchContext, Query query) throws SearchException
SearchExceptionpublic static void setBeanIdentifier(java.lang.String beanIdentifier)
beanIdentifier - the Spring bean ID for this beanpublic static void subscribeFileEntryType(long groupId,
long fileEntryTypeId)
throws PortalException
groupId - the primary key of the file entry type's groupfileEntryTypeId - the primary key of the file entry typePortalException - if the user or group could not be found, or if
subscribing was not permissiblepublic static void subscribeFolder(long groupId,
long folderId)
throws PortalException
groupId - the primary key of the folder's groupfolderId - the primary key of the folderPortalException - if the user or group could not be found, or if
subscribing was not permissible@Deprecated
public static void unlockFileEntry(long fileEntryId)
throws PortalException
checkInFileEntry(long,
boolean, String, ServiceContext).PortalException@Deprecated
public static void unlockFileEntry(long fileEntryId,
java.lang.String lockUuid)
throws PortalException
checkInFileEntry(long,
String).PortalExceptionpublic static void unlockFolder(long repositoryId,
long folderId,
java.lang.String lockUuid)
throws PortalException
repositoryId - the primary key of the repositoryfolderId - the primary key of the folderlockUuid - the lock's UUIDPortalException - if the repository or folder could not be foundpublic static void unlockFolder(long repositoryId,
long parentFolderId,
java.lang.String name,
java.lang.String lockUuid)
throws PortalException
repositoryId - the primary key of the repositoryparentFolderId - the primary key of the parent foldername - the folder's namelockUuid - the lock's UUIDPortalException - if the repository or folder could not be foundpublic static void unsubscribeFileEntryType(long groupId,
long fileEntryTypeId)
throws PortalException
groupId - the primary key of the file entry type's groupfileEntryTypeId - the primary key of the file entry typePortalException - if the user or group could not be found, or if
unsubscribing was not permissiblepublic static void unsubscribeFolder(long groupId,
long folderId)
throws PortalException
groupId - the primary key of the folder's groupfolderId - the primary key of the folderPortalException - if the user or group could not be found, or if
unsubscribing was not permissiblepublic static FileEntry updateFileEntry(long fileEntryId, java.lang.String sourceFileName, java.lang.String mimeType, java.lang.String title, java.lang.String description, java.lang.String changeLog, boolean majorVersion, byte[] bytes, ServiceContext serviceContext) throws PortalException
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.
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: PortalException - if the file entry could not be foundpublic static FileEntry updateFileEntry(long fileEntryId, java.lang.String sourceFileName, java.lang.String mimeType, java.lang.String title, java.lang.String description, java.lang.String changeLog, boolean majorVersion, java.io.File file, ServiceContext serviceContext) throws PortalException
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.
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 - 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 file entry could not be foundpublic static FileEntry updateFileEntry(long fileEntryId, java.lang.String sourceFileName, java.lang.String mimeType, java.lang.String title, java.lang.String description, java.lang.String changeLog, boolean majorVersion, java.io.InputStream is, long size, ServiceContext serviceContext) throws PortalException
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.
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: PortalException - if the file entry could not be foundpublic static FileEntry updateFileEntryAndCheckIn(long fileEntryId, java.lang.String sourceFileName, java.lang.String mimeType, java.lang.String title, java.lang.String description, java.lang.String changeLog, boolean majorVersion, java.io.File file, ServiceContext serviceContext) throws PortalException
PortalExceptionpublic static FileEntry updateFileEntryAndCheckIn(long fileEntryId, java.lang.String sourceFileName, java.lang.String mimeType, java.lang.String title, java.lang.String description, java.lang.String changeLog, boolean majorVersion, java.io.InputStream is, long size, ServiceContext serviceContext) throws PortalException
PortalExceptionpublic static FileShortcut updateFileShortcut(long fileShortcutId, long folderId, long toFileEntryId, ServiceContext serviceContext) throws PortalException
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.PortalException - if the file shortcut, folder, or file entry could
not be foundpublic static Folder updateFolder(long folderId, java.lang.String name, java.lang.String description, ServiceContext serviceContext) throws PortalException
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: workflowDefinition appended by the
fileEntryTypeId (optionally 0).PortalException - if the current or new parent folder could not be
found or if the new parent folder's information was invalidpublic static boolean verifyFileEntryCheckOut(long repositoryId,
long fileEntryId,
java.lang.String lockUuid)
throws PortalException
true if the file entry is checked out. This method
is primarily used by WebDAV.repositoryId - the primary key for the repositoryfileEntryId - the primary key for the file entrylockUuid - the lock's UUIDtrue if the file entry is checked out;
false otherwisePortalException - if the file entry could not be foundpublic static boolean verifyFileEntryLock(long repositoryId,
long fileEntryId,
java.lang.String lockUuid)
throws PortalException
PortalExceptionpublic static boolean verifyInheritableLock(long repositoryId,
long folderId,
java.lang.String lockUuid)
throws PortalException
true if the inheritable lock exists. This method is
primarily used by WebDAV.repositoryId - the primary key for the repositoryfolderId - the primary key for the folderlockUuid - the lock's UUIDtrue if the inheritable lock exists;
false otherwisePortalException - if the folder could not be foundpublic static DLAppService getService()
@Deprecated public void setService(DLAppService service)