|
Liferay 6.2.0 | |||||||||
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.http.DLAppServiceSoap
@ProviderType public class DLAppServiceSoap
Provides the SOAP utility for the
DLAppServiceUtil
service utility. The
static methods of this class calls the same methods of the service utility.
However, the signatures are different because it is difficult for SOAP to
support certain types.
The benefits of using the SOAP utility is that it is cross platform compatible. SOAP allows different languages like Java, .NET, C++, PHP, and even Perl, to call the generated services. One drawback of SOAP is that it is slow because it needs to serialize all calls into a text format (XML).
You can see a list of services at http://localhost:8080/api/axis. Set the property axis.servlet.hosts.allowed in portal.properties to configure security.
The SOAP utility is only generated for remote services.
DLAppServiceHttp
,
DLAppServiceUtil
Constructor Summary | |
---|---|
DLAppServiceSoap()
|
Method Summary | |
---|---|
static FileEntrySoap |
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 DLFileShortcutSoap |
addFileShortcut(long repositoryId,
long folderId,
long toFileEntryId,
ServiceContext serviceContext)
Adds a file shortcut to the existing file entry. |
static FolderSoap |
addFolder(long repositoryId,
long parentFolderId,
String name,
String description,
ServiceContext serviceContext)
Adds a folder. |
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)
Deprecated. As of 6.2.0, replaced by checkInFileEntry(long,
String, ServiceContext) |
static void |
checkInFileEntry(long fileEntryId,
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 FileEntrySoap |
checkOutFileEntry(long fileEntryId,
String owner,
long expirationTime,
ServiceContext serviceContext)
Checks out the file entry. |
static FolderSoap |
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 FileEntrySoap[] |
getFileEntries(long repositoryId,
long folderId)
Returns all the file entries in the folder. |
static FileEntrySoap[] |
getFileEntries(long repositoryId,
long folderId,
int start,
int end)
Returns a range of all the file entries in the folder. |
static FileEntrySoap[] |
getFileEntries(long repositoryId,
long folderId,
int start,
int end,
OrderByComparator obc)
Returns an ordered range of all the file entries in the folder. |
static FileEntrySoap[] |
getFileEntries(long repositoryId,
long folderId,
long fileEntryTypeId)
Returns the file entries with the file entry type in the folder. |
static FileEntrySoap[] |
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 FileEntrySoap[] |
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 FileEntrySoap[] |
getFileEntries(long repositoryId,
long folderId,
String[] mimeTypes)
|
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 FileEntrySoap |
getFileEntry(long fileEntryId)
Returns the file entry with the primary key. |
static FileEntrySoap |
getFileEntry(long groupId,
long folderId,
String title)
Returns the file entry with the title in the folder. |
static FileEntrySoap |
getFileEntryByUuidAndGroupId(String uuid,
long groupId)
Returns the file entry with the UUID and group. |
static DLFileShortcutSoap |
getFileShortcut(long fileShortcutId)
Returns the file shortcut with the primary key. |
static FolderSoap |
getFolder(long folderId)
Returns the folder with the primary key. |
static FolderSoap |
getFolder(long repositoryId,
long parentFolderId,
String name)
Returns the folder with the name in the parent folder. |
static FolderSoap[] |
getFolders(long repositoryId,
long parentFolderId)
Returns all immediate subfolders of the parent folder. |
static FolderSoap[] |
getFolders(long repositoryId,
long parentFolderId,
boolean includeMountFolders)
Returns all immediate subfolders of the parent folder, optionally including mount folders for third-party repositories. |
static FolderSoap[] |
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 FolderSoap[] |
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 FolderSoap[] |
getFolders(long repositoryId,
long parentFolderId,
int status,
boolean includeMountFolders,
int start,
int end,
OrderByComparator obc)
Returns an ordered range of all the immediate subfolders of the parent folder. |
static FolderSoap[] |
getFolders(long repositoryId,
long parentFolderId,
int start,
int end)
Returns a range of all the immediate subfolders of the parent folder. |
static FolderSoap[] |
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 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 |
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,
Long[] folderIds,
int status)
Returns the number of immediate subfolders and file entries across the folders. |
static FileEntrySoap[] |
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 FileEntrySoap[] |
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 FileEntrySoap[] |
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 FileEntrySoap[] |
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 FileEntrySoap[] |
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 FolderSoap[] |
getMountFolders(long repositoryId,
long parentFolderId)
Returns all immediate subfolders of the parent folder that are used for mounting third-party repositories. |
static FolderSoap[] |
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 FolderSoap[] |
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 Long[] |
getSubfolderIds(long repositoryId,
long folderId)
Returns all the descendant folders of the folder with the primary key. |
static void |
getSubfolderIds(long repositoryId,
Long[] folderIds,
long folderId)
|
static 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 FileEntrySoap |
moveFileEntry(long fileEntryId,
long newFolderId,
ServiceContext serviceContext)
Moves the file entry to the new folder. |
static FileEntrySoap |
moveFileEntryFromTrash(long fileEntryId,
long newFolderId,
ServiceContext serviceContext)
Moves the file entry from a trashed folder to the new folder. |
static FileEntrySoap |
moveFileEntryToTrash(long fileEntryId)
Moves the file entry with the primary key to the trash portlet. |
static DLFileShortcutSoap |
moveFileShortcutFromTrash(long fileShortcutId,
long newFolderId,
ServiceContext serviceContext)
Moves the file shortcut from a trashed folder to the new folder. |
static DLFileShortcutSoap |
moveFileShortcutToTrash(long fileShortcutId)
Moves the file shortcut with the primary key to the trash portlet. |
static FolderSoap |
moveFolder(long folderId,
long parentFolderId,
ServiceContext serviceContext)
Moves the folder to the new parent folder with the primary key. |
static FolderSoap |
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 FolderSoap |
moveFolderToTrash(long folderId)
Moves the folder with the primary key to the trash portlet. |
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,
String version,
ServiceContext serviceContext)
Reverts the file entry to a previous version. |
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,
String lockUuid)
Deprecated. As of 6.2.0, replaced by 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 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 FileEntrySoap |
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 DLFileShortcutSoap |
updateFileShortcut(long fileShortcutId,
long folderId,
long toFileEntryId,
ServiceContext serviceContext)
Updates a file shortcut to the existing file entry. |
static FolderSoap |
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 DLAppServiceSoap()
Method Detail |
---|
public static FileEntrySoap addFileEntry(long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String description, String changeLog, byte[] bytes, ServiceContext serviceContext) throws RemoteException
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 occurred
RemoteException
public static DLFileShortcutSoap addFileShortcut(long repositoryId, long folderId, long toFileEntryId, ServiceContext serviceContext) throws RemoteException
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 occurred
RemoteException
public static FolderSoap addFolder(long repositoryId, long parentFolderId, String name, String description, ServiceContext serviceContext) throws RemoteException
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 occurred
RemoteException
public static void cancelCheckOut(long fileEntryId) throws RemoteException
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 occurred
RemoteException
checkInFileEntry(long, boolean, String, ServiceContext)
,
checkOutFileEntry(long, ServiceContext)
public static void checkInFileEntry(long fileEntryId, boolean majorVersion, String changeLog, ServiceContext serviceContext) throws RemoteException
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 occurred
RemoteException
cancelCheckOut(long)
,
checkOutFileEntry(long, ServiceContext)
public static void checkInFileEntry(long fileEntryId, String lockUuid) throws RemoteException
checkInFileEntry(long,
String, ServiceContext)
RemoteException
public static void checkInFileEntry(long fileEntryId, String lockUuid, ServiceContext serviceContext) throws RemoteException
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 applied
PortalException
- if the file entry could not be found
SystemException
- if a system exception occurred
RemoteException
cancelCheckOut(long)
,
checkOutFileEntry(long, String, long, ServiceContext)
public static void checkOutFileEntry(long fileEntryId, ServiceContext serviceContext) throws RemoteException
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 occurred
RemoteException
cancelCheckOut(long)
,
checkInFileEntry(long, boolean, String, ServiceContext)
public static FileEntrySoap checkOutFileEntry(long fileEntryId, String owner, long expirationTime, ServiceContext serviceContext) throws RemoteException
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
RemoteException
See Also:
cancelCheckOut(long)
,
checkInFileEntry(long, String)
copyFolder
public static FolderSoap copyFolder(long repositoryId,
long sourceFolderId,
long parentFolderId,
String name,
String description,
ServiceContext serviceContext)
throws RemoteException
- 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
RemoteException
deleteFileEntry
public static void deleteFileEntry(long fileEntryId)
throws RemoteException
- 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
RemoteException
deleteFileEntryByTitle
public static void deleteFileEntryByTitle(long repositoryId,
long folderId,
String title)
throws RemoteException
- 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
RemoteException
deleteFileShortcut
public static void deleteFileShortcut(long fileShortcutId)
throws RemoteException
- 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
RemoteException
deleteFileVersion
public static void deleteFileVersion(long fileEntryId,
String version)
throws RemoteException
- 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
RemoteException
deleteFolder
public static void deleteFolder(long folderId)
throws RemoteException
- 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
RemoteException
deleteFolder
public static void deleteFolder(long repositoryId,
long parentFolderId,
String name)
throws RemoteException
- 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
RemoteException
deleteTempFileEntry
public static void deleteTempFileEntry(long groupId,
long folderId,
String fileName,
String tempFolderName)
throws RemoteException
- 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
RemoteException
- See Also:
TempFileUtil
getFileEntries
public static FileEntrySoap[] getFileEntries(long repositoryId,
long folderId)
throws RemoteException
- 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
RemoteException
getFileEntries
public static FileEntrySoap[] getFileEntries(long repositoryId,
long folderId,
int start,
int end)
throws RemoteException
- 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
RemoteException
getFileEntries
public static FileEntrySoap[] getFileEntries(long repositoryId,
long folderId,
int start,
int end,
OrderByComparator obc)
throws RemoteException
- 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
RemoteException
getFileEntries
public static FileEntrySoap[] getFileEntries(long repositoryId,
long folderId,
long fileEntryTypeId)
throws RemoteException
- 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
RemoteException
getFileEntries
public static FileEntrySoap[] getFileEntries(long repositoryId,
long folderId,
long fileEntryTypeId,
int start,
int end)
throws RemoteException
- 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
RemoteException
getFileEntries
public static FileEntrySoap[] getFileEntries(long repositoryId,
long folderId,
long fileEntryTypeId,
int start,
int end,
OrderByComparator obc)
throws RemoteException
- 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
RemoteException
getFileEntries
public static FileEntrySoap[] getFileEntries(long repositoryId,
long folderId,
String[] mimeTypes)
throws RemoteException
- Throws:
RemoteException
getFileEntriesAndFileShortcutsCount
public static int getFileEntriesAndFileShortcutsCount(long repositoryId,
long folderId,
int status)
throws RemoteException
- 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
RemoteException
getFileEntriesAndFileShortcutsCount
public static int getFileEntriesAndFileShortcutsCount(long repositoryId,
long folderId,
int status,
String[] mimeTypes)
throws RemoteException
- 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
RemoteException
getFileEntriesCount
public static int getFileEntriesCount(long repositoryId,
long folderId)
throws RemoteException
- 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
RemoteException
getFileEntriesCount
public static int getFileEntriesCount(long repositoryId,
long folderId,
long fileEntryTypeId)
throws RemoteException
- 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
RemoteException
getFileEntry
public static FileEntrySoap getFileEntry(long fileEntryId)
throws RemoteException
- 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
RemoteException
getFileEntry
public static FileEntrySoap getFileEntry(long groupId,
long folderId,
String title)
throws RemoteException
- 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
RemoteException
getFileEntryByUuidAndGroupId
public static FileEntrySoap getFileEntryByUuidAndGroupId(String uuid,
long groupId)
throws RemoteException
- Returns the file entry with the UUID and group.
- Parameters:
uuid
- the file entry's UUIDgroupId
- 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
RemoteException
getFileShortcut
public static DLFileShortcutSoap getFileShortcut(long fileShortcutId)
throws RemoteException
- 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
RemoteException
getFolder
public static FolderSoap getFolder(long folderId)
throws RemoteException
- 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
RemoteException
getFolder
public static FolderSoap getFolder(long repositoryId,
long parentFolderId,
String name)
throws RemoteException
- 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
RemoteException
getFolders
public static FolderSoap[] getFolders(long repositoryId,
long parentFolderId)
throws RemoteException
- 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
RemoteException
getFolders
public static FolderSoap[] getFolders(long repositoryId,
long parentFolderId,
boolean includeMountFolders)
throws RemoteException
- 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
RemoteException
getFolders
public static FolderSoap[] getFolders(long repositoryId,
long parentFolderId,
boolean includeMountFolders,
int start,
int end)
throws RemoteException
- 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
RemoteException
getFolders
public static FolderSoap[] getFolders(long repositoryId,
long parentFolderId,
boolean includeMountFolders,
int start,
int end,
OrderByComparator obc)
throws RemoteException
- 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
RemoteException
getFolders
public static FolderSoap[] getFolders(long repositoryId,
long parentFolderId,
int status,
boolean includeMountFolders,
int start,
int end,
OrderByComparator obc)
throws RemoteException
- 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 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
)
- 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
RemoteException
getFolders
public static FolderSoap[] getFolders(long repositoryId,
long parentFolderId,
int start,
int end)
throws RemoteException
- 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
RemoteException
getFolders
public static FolderSoap[] getFolders(long repositoryId,
long parentFolderId,
int start,
int end,
OrderByComparator obc)
throws RemoteException
- 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
RemoteException
getFoldersAndFileEntriesAndFileShortcutsCount
public static int getFoldersAndFileEntriesAndFileShortcutsCount(long repositoryId,
long folderId,
int status,
boolean includeMountFolders)
throws RemoteException
- 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
RemoteException
getFoldersAndFileEntriesAndFileShortcutsCount
public static int getFoldersAndFileEntriesAndFileShortcutsCount(long repositoryId,
long folderId,
int status,
String[] mimeTypes,
boolean includeMountFolders)
throws RemoteException
- Throws:
RemoteException
getFoldersCount
public static int getFoldersCount(long repositoryId,
long parentFolderId)
throws RemoteException
- 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
RemoteException
getFoldersCount
public static int getFoldersCount(long repositoryId,
long parentFolderId,
boolean includeMountFolders)
throws RemoteException
- 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
RemoteException
getFoldersCount
public static int getFoldersCount(long repositoryId,
long parentFolderId,
int status,
boolean includeMountFolders)
throws RemoteException
- 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 folderstatus
- the workflow statusincludeMountFolders
- 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
RemoteException
getFoldersFileEntriesCount
public static int getFoldersFileEntriesCount(long repositoryId,
Long[] folderIds,
int status)
throws RemoteException
- 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
RemoteException
getGroupFileEntries
public static FileEntrySoap[] getGroupFileEntries(long groupId,
long userId,
int start,
int end)
throws RemoteException
- 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
RemoteException
getGroupFileEntries
public static FileEntrySoap[] getGroupFileEntries(long groupId,
long userId,
int start,
int end,
OrderByComparator obc)
throws RemoteException
- 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
RemoteException
getGroupFileEntries
public static FileEntrySoap[] getGroupFileEntries(long groupId,
long userId,
long rootFolderId,
int start,
int end)
throws RemoteException
- 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
RemoteException
getGroupFileEntries
public static FileEntrySoap[] getGroupFileEntries(long groupId,
long userId,
long rootFolderId,
int start,
int end,
OrderByComparator obc)
throws RemoteException
- 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
RemoteException
getGroupFileEntries
public static FileEntrySoap[] getGroupFileEntries(long groupId,
long userId,
long rootFolderId,
String[] mimeTypes,
int status,
int start,
int end,
OrderByComparator obc)
throws RemoteException
- Throws:
RemoteException
getGroupFileEntriesCount
public static int getGroupFileEntriesCount(long groupId,
long userId)
throws RemoteException
- 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
RemoteException
getGroupFileEntriesCount
public static int getGroupFileEntriesCount(long groupId,
long userId,
long rootFolderId)
throws RemoteException
- 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
RemoteException
getGroupFileEntriesCount
public static int getGroupFileEntriesCount(long groupId,
long userId,
long rootFolderId,
String[] mimeTypes,
int status)
throws RemoteException
- Throws:
RemoteException
getMountFolders
public static FolderSoap[] getMountFolders(long repositoryId,
long parentFolderId)
throws RemoteException
- 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
RemoteException
getMountFolders
public static FolderSoap[] getMountFolders(long repositoryId,
long parentFolderId,
int start,
int end)
throws RemoteException
- 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
RemoteException
getMountFolders
public static FolderSoap[] getMountFolders(long repositoryId,
long parentFolderId,
int start,
int end,
OrderByComparator obc)
throws RemoteException
- 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
RemoteException
getMountFoldersCount
public static int getMountFoldersCount(long repositoryId,
long parentFolderId)
throws RemoteException
- 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
RemoteException
getSubfolderIds
public static void getSubfolderIds(long repositoryId,
Long[] folderIds,
long folderId)
throws RemoteException
- Throws:
RemoteException
getSubfolderIds
public static Long[] getSubfolderIds(long repositoryId,
long folderId)
throws RemoteException
- 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
RemoteException
getSubfolderIds
public static Long[] getSubfolderIds(long repositoryId,
long folderId,
boolean recurse)
throws RemoteException
- 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
RemoteException
getTempFileEntryNames
public static String[] getTempFileEntryNames(long groupId,
long folderId,
String tempFolderName)
throws RemoteException
- 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
RemoteException
- See Also:
#addTempFileEntry(long, long, String, String, File, String)
,
TempFileUtil
moveFileEntry
public static FileEntrySoap moveFileEntry(long fileEntryId,
long newFolderId,
ServiceContext serviceContext)
throws RemoteException
- 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
RemoteException
moveFileEntryFromTrash
public static FileEntrySoap moveFileEntryFromTrash(long fileEntryId,
long newFolderId,
ServiceContext serviceContext)
throws RemoteException
- Moves the file entry from a trashed folder 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
RemoteException
moveFileEntryToTrash
public static FileEntrySoap moveFileEntryToTrash(long fileEntryId)
throws RemoteException
- Moves the file entry with the primary key to the trash portlet.
- Parameters:
fileEntryId
- the primary key of the file entry
- Returns:
- the file entry
- Throws:
PortalException
- if the file entry could not be found
SystemException
- if a system exception occurred
RemoteException
moveFileShortcutFromTrash
public static DLFileShortcutSoap moveFileShortcutFromTrash(long fileShortcutId,
long newFolderId,
ServiceContext serviceContext)
throws RemoteException
- Moves the file shortcut from a trashed folder to the new folder.
- Parameters:
fileShortcutId
- the primary key of the file shortcutnewFolderId
- the primary key of the new folderserviceContext
- the service context to be applied
- Returns:
- the file shortcut
- Throws:
PortalException
- if the file entry or the new folder could not be
found
SystemException
- if a system exception occurred
RemoteException
moveFileShortcutToTrash
public static DLFileShortcutSoap moveFileShortcutToTrash(long fileShortcutId)
throws RemoteException
- Moves the file shortcut with the primary key to the trash portlet.
- Parameters:
fileShortcutId
- the primary key of the file shortcut
- Returns:
- the file shortcut
- Throws:
PortalException
- if the file shortcut could not be found
SystemException
- if a system exception occurred
RemoteException
moveFolder
public static FolderSoap moveFolder(long folderId,
long parentFolderId,
ServiceContext serviceContext)
throws RemoteException
- 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
RemoteException
moveFolderFromTrash
public static FolderSoap moveFolderFromTrash(long folderId,
long parentFolderId,
ServiceContext serviceContext)
throws RemoteException
- Moves the folder with the primary key from the trash portlet 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
RemoteException
moveFolderToTrash
public static FolderSoap moveFolderToTrash(long folderId)
throws RemoteException
- Moves the folder with the primary key to the trash portlet.
- Parameters:
folderId
- the primary key of the folder
- Returns:
- the file entry
- Throws:
PortalException
- if the folder could not be found
SystemException
- if a system exception occurred
RemoteException
restoreFileEntryFromTrash
public static void restoreFileEntryFromTrash(long fileEntryId)
throws RemoteException
- Restores the file entry with the primary key from the trash portlet.
- 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
RemoteException
restoreFileShortcutFromTrash
public static void restoreFileShortcutFromTrash(long fileShortcutId)
throws RemoteException
- Restores the file shortcut with the primary key from the trash portlet.
- 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
RemoteException
restoreFolderFromTrash
public static void restoreFolderFromTrash(long folderId)
throws RemoteException
- Restores the folder with the primary key from the trash portlet.
- Parameters:
folderId
- the primary key of the folder
- Throws:
PortalException
- if the folder could not be found
SystemException
- if a system exception occurred
RemoteException
revertFileEntry
public static void revertFileEntry(long fileEntryId,
String version,
ServiceContext serviceContext)
throws RemoteException
- 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
RemoteException
subscribeFileEntryType
public static void subscribeFileEntryType(long groupId,
long fileEntryTypeId)
throws RemoteException
- Subscribe the user to changes in documents of the file entry type. This
method is only supported by the Liferay repository.
- Parameters:
groupId
- the primary key of the file entry type's groupfileEntryTypeId
- the primary key of the file entry type
- Throws:
PortalException
- if the user or group could not be found, or if
subscribing was not permissible
SystemException
- if a system exception occurred
RemoteException
subscribeFolder
public static void subscribeFolder(long groupId,
long folderId)
throws RemoteException
- Subscribe the user to document changes in the folder. This method is only
supported by the Liferay repository.
- Parameters:
groupId
- the primary key of the folder's groupfolderId
- the primary key of the folder
- Throws:
PortalException
- if the user or group could not be found, or if
subscribing was not permissible
SystemException
- if a system exception occurred
RemoteException
unlockFileEntry
public static void unlockFileEntry(long fileEntryId)
throws RemoteException
- Deprecated. As of 6.2.0, replaced by
checkInFileEntry(long,
boolean, String, ServiceContext)
.
- Throws:
RemoteException
unlockFileEntry
public static void unlockFileEntry(long fileEntryId,
String lockUuid)
throws RemoteException
- Deprecated. As of 6.2.0, replaced by
checkInFileEntry(long,
String)
.
- Throws:
RemoteException
unlockFolder
public static void unlockFolder(long repositoryId,
long folderId,
String lockUuid)
throws RemoteException
- 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 UUID
- Throws:
PortalException
- if the repository or folder could not be found
SystemException
- if a system exception occurred
RemoteException
unlockFolder
public static void unlockFolder(long repositoryId,
long parentFolderId,
String name,
String lockUuid)
throws RemoteException
- 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 UUID
- Throws:
PortalException
- if the repository or folder could not be found
SystemException
- if a system exception occurred
RemoteException
unsubscribeFileEntryType
public static void unsubscribeFileEntryType(long groupId,
long fileEntryTypeId)
throws RemoteException
- Unsubscribe the user from changes in documents of the file entry type.
This method is only supported by the Liferay repository.
- Parameters:
groupId
- the primary key of the file entry type's groupfileEntryTypeId
- the primary key of the file entry type
- Throws:
PortalException
- if the user or group could not be found, or if
unsubscribing was not permissible
SystemException
- if a system exception occurred
RemoteException
unsubscribeFolder
public static void unsubscribeFolder(long groupId,
long folderId)
throws RemoteException
- Unsubscribe the user from document changes in the folder. This method is
only supported by the Liferay repository.
- Parameters:
groupId
- the primary key of the folder's groupfolderId
- the primary key of the folder
- Throws:
PortalException
- if the user or group could not be found, or if
unsubscribing was not permissible
SystemException
- if a system exception occurred
RemoteException
updateFileEntry
public static FileEntrySoap updateFileEntry(long fileEntryId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
boolean majorVersion,
byte[] bytes,
ServiceContext serviceContext)
throws RemoteException
- 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
RemoteException
updateFileShortcut
public static DLFileShortcutSoap updateFileShortcut(long fileShortcutId,
long folderId,
long toFileEntryId,
ServiceContext serviceContext)
throws RemoteException
- 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
RemoteException
updateFolder
public static FolderSoap updateFolder(long folderId,
String name,
String description,
ServiceContext serviceContext)
throws RemoteException
- 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
RemoteException
verifyFileEntryCheckOut
public static boolean verifyFileEntryCheckOut(long repositoryId,
long fileEntryId,
String lockUuid)
throws RemoteException
- 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 UUID
- 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
RemoteException
verifyFileEntryLock
public static boolean verifyFileEntryLock(long repositoryId,
long fileEntryId,
String lockUuid)
throws RemoteException
- Throws:
RemoteException
verifyInheritableLock
public static boolean verifyInheritableLock(long repositoryId,
long folderId,
String lockUuid)
throws RemoteException
- 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 UUID
- Returns:
true
if the inheritable lock exists;
false
otherwise
- Throws:
PortalException
- if the folder could not be found
SystemException
- if a system exception occurred
RemoteException
Overview
Package
Class
Use
Tree
Deprecated
Index
Help
Liferay 6.2.0
PREV CLASS
NEXT CLASS
FRAMES
NO FRAMES
All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD
DETAIL: FIELD | CONSTR | METHOD