Liferay 7.0-ce-b4

com.liferay.portlet.documentlibrary.service.http
Class DLAppServiceSoap

java.lang.Object
  extended by com.liferay.portlet.documentlibrary.service.http.DLAppServiceSoap

@ProviderType
public class DLAppServiceSoap
extends Object

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.

See Also:
DLAppServiceHttp, DLAppServiceUtil
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

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 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 folderName, String fileName)
          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 name-ordered range of all the file entries in the folder.
static FileEntrySoap[] 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 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 name-ordered 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<FileEntry> 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 FileEntrySoap[] getFileEntries(long repositoryId, long folderId, String[] mimeTypes, int start, int end, OrderByComparator<FileEntry> obc)
           
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 int getFileEntriesCount(long repositoryId, long folderId, String[] mimeTypes)
           
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 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 name-ordered 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<Folder> 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<Folder> 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 name-ordered range of all the immediate subfolders of the parent folder.
static FolderSoap[] 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 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<FileEntry> 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<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 FileEntrySoap[] getGroupFileEntries(long groupId, long userId, long rootFolderId, 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, 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 name-ordered 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<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 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[] getTempFileNames(long groupId, long folderId, 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, String owner, boolean inheritable, long expirationTime)
          Locks the folder.
static FileEntrySoap moveFileEntry(long fileEntryId, long newFolderId, ServiceContext serviceContext)
          Moves the file entry to the new folder.
static FolderSoap moveFolder(long folderId, long parentFolderId, ServiceContext serviceContext)
          Moves the folder to the new parent folder with the primary key.
static Lock refreshFileEntryLock(String lockUuid, long companyId, long expirationTime)
          Refreshes the lock for the file entry.
static Lock refreshFolderLock(String lockUuid, long companyId, long expirationTime)
          Refreshes the lock for the folder.
static void revertFileEntry(long fileEntryId, String version, ServiceContext serviceContext)
          Reverts the file entry to a previous version.
static 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 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

DLAppServiceSoap

public DLAppServiceSoap()
Method Detail

addFileEntry

public static FileEntrySoap addFileEntry(long repositoryId,
                                         long folderId,
                                         String sourceFileName,
                                         String mimeType,
                                         String title,
                                         String description,
                                         String changeLog,
                                         byte[] bytes,
                                         ServiceContext serviceContext)
                                  throws RemoteException
Adds a file entry and associated metadata. It is created based on a byte array.

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.

Parameters:
repositoryId - the primary key of the repository
folderId - the primary key of the file entry's parent folder
sourceFileName - the original file's name
mimeType - the file's MIME type
title - the name to be assigned to the file (optionally null )
description - the file's description
changeLog - the file's version change log
bytes - 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:
RemoteException

addFolder

public static FolderSoap addFolder(long repositoryId,
                                   long parentFolderId,
                                   String name,
                                   String description,
                                   ServiceContext serviceContext)
                            throws RemoteException
Adds a folder.

Parameters:
repositoryId - the primary key of the repository
parentFolderId - the primary key of the folder's parent folder
name - the folder's name
description - the folder's description
serviceContext - 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
Returns:
the folder
Throws:
RemoteException

cancelCheckOut

public static void cancelCheckOut(long fileEntryId)
                           throws RemoteException
Cancels the check out of the file entry. If a user has not checked out the specified file entry, invoking this method will result in no changes.

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.

Parameters:
fileEntryId - the primary key of the file entry to cancel the checkout
Throws:
RemoteException
See Also:
checkInFileEntry(long, boolean, String, ServiceContext), checkOutFileEntry(long, ServiceContext)

checkInFileEntry

public static void checkInFileEntry(long fileEntryId,
                                    boolean majorVersion,
                                    String changeLog,
                                    ServiceContext serviceContext)
                             throws RemoteException
Checks in the file entry. If a user has not checked out the specified file entry, invoking this method will result in no changes.

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.

Parameters:
fileEntryId - the primary key of the file entry to check in
majorVersion - whether the new file version is a major version
changeLog - the file's version change log
serviceContext - the service context to be applied
Throws:
RemoteException
See Also:
cancelCheckOut(long), checkOutFileEntry(long, ServiceContext)

checkInFileEntry

@Deprecated
public static void checkInFileEntry(long fileEntryId,
                                               String lockUuid)
                             throws RemoteException
Deprecated. As of 6.2.0, replaced by checkInFileEntry(long, String, ServiceContext)

Throws:
RemoteException

checkInFileEntry

public static void checkInFileEntry(long fileEntryId,
                                    String lockUuid,
                                    ServiceContext serviceContext)
                             throws RemoteException
Checks in the file entry using the lock's UUID. If a user has not checked out the specified file entry, invoking this method will result in no changes. This method is primarily used by WebDAV.

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.

Parameters:
fileEntryId - the primary key of the file entry to check in
lockUuid - the lock's UUID
serviceContext - the service context to be applied
Throws:
RemoteException
See Also:
cancelCheckOut(long), checkOutFileEntry(long, String, long, ServiceContext)

checkOutFileEntry

public static void checkOutFileEntry(long fileEntryId,
                                     ServiceContext serviceContext)
                              throws RemoteException
Check out a file entry.

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.

Parameters:
fileEntryId - the file entry to check out
serviceContext - the service context to be applied
Throws:
RemoteException
See Also:
cancelCheckOut(long), checkInFileEntry(long, boolean, String, ServiceContext)

checkOutFileEntry

public static FileEntrySoap checkOutFileEntry(long fileEntryId,
                                              String owner,
                                              long expirationTime,
                                              ServiceContext serviceContext)
                                       throws RemoteException
Checks out the file entry. This method is primarily used by WebDAV.

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.

Parameters:
fileEntryId - the file entry to check out
owner - 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:
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 repository
sourceFolderId - the primary key of the folder to copy
parentFolderId - the primary key of the new folder's parent folder
name - the new folder's name
description - the new folder's description
serviceContext - the service context to be applied
Returns:
the folder
Throws:
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:
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 repository
folderId - the primary key of the file entry's parent folder
title - the file entry's title
Throws:
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:
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 entry
version - the version label of the file version
Throws:
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:
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 repository
parentFolderId - the primary key of the folder's parent folder
name - the folder's name
Throws:
RemoteException

deleteTempFileEntry

public static void deleteTempFileEntry(long groupId,
                                       long folderId,
                                       String folderName,
                                       String fileName)
                                throws RemoteException
Deletes the temporary file entry.

Parameters:
groupId - the primary key of the group
folderId - the primary key of the folder where the file entry was eventually to reside
folderName - the temporary folder's name
fileName - the file's original name
Throws:
RemoteException
See Also:
TempFileEntryUtil

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 repository
folderId - the primary key of the file entry's folder
Returns:
the file entries in the folder
Throws:
RemoteException

getFileEntries

public static FileEntrySoap[] getFileEntries(long repositoryId,
                                             long folderId,
                                             int start,
                                             int end)
                                      throws RemoteException
Returns a name-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 repository
folderId - the primary key of the file entry's folder
start - the lower bound of the range of results
end - the upper bound of the range of results (not inclusive)
Returns:
the name-ordered range of file entries in the folder
Throws:
RemoteException

getFileEntries

public static FileEntrySoap[] getFileEntries(long repositoryId,
                                             long folderId,
                                             int start,
                                             int end,
                                             OrderByComparator<FileEntry> 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 repository
folderId - the primary key of the file entry's folder
start - the lower bound of the range of results
end - 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:
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 repository
folderId - the primary key of the file entry's folder
fileEntryTypeId - the primary key of the file entry type
Returns:
the file entries with the file entry type in the folder
Throws:
RemoteException

getFileEntries

public static FileEntrySoap[] getFileEntries(long repositoryId,
                                             long folderId,
                                             long fileEntryTypeId,
                                             int start,
                                             int end)
                                      throws RemoteException
Returns a name-ordered range of all the file entries with the file entry type in the folder.

Parameters:
repositoryId - the primary key of the file entry's repository
folderId - the primary key of the file entry's folder
fileEntryTypeId - the primary key of the file entry type
start - the lower bound of the range of results
end - the upper bound of the range of results (not inclusive)
Returns:
the name-ordered range of the file entries in the folder
Throws:
RemoteException

getFileEntries

public static FileEntrySoap[] getFileEntries(long repositoryId,
                                             long folderId,
                                             long fileEntryTypeId,
                                             int start,
                                             int end,
                                             OrderByComparator<FileEntry> 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 repository
folderId - the primary key of the folder
fileEntryTypeId - the primary key of the file entry type
start - the lower bound of the range of results
end - 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:
RemoteException

getFileEntries

public static FileEntrySoap[] getFileEntries(long repositoryId,
                                             long folderId,
                                             String[] mimeTypes)
                                      throws RemoteException
Throws:
RemoteException

getFileEntries

public static FileEntrySoap[] getFileEntries(long repositoryId,
                                             long folderId,
                                             String[] mimeTypes,
                                             int start,
                                             int end,
                                             OrderByComparator<FileEntry> obc)
                                      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 repository
folderId - the primary key of the folder
status - the workflow status
Returns:
the number of file entries and shortcuts in the folder
Throws:
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 repository
folderId - the primary key of the folder
status - the workflow status
mimeTypes - allowed media types
Returns:
the number of file entries and shortcuts in the folder
Throws:
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 repository
folderId - the primary key of the file entry's folder
Returns:
the number of file entries in the folder
Throws:
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 repository
folderId - the primary key of the file entry's folder
fileEntryTypeId - the primary key of the file entry type
Returns:
the number of file entries with the file entry type in the folder
Throws:
RemoteException

getFileEntriesCount

public static int getFileEntriesCount(long repositoryId,
                                      long folderId,
                                      String[] mimeTypes)
                               throws RemoteException
Throws:
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:
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 group
folderId - the primary key of the file entry's folder
title - the file entry's title
Returns:
the file entry with the title in the folder
Throws:
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 UUID
groupId - the primary key of the file entry's group
Returns:
the file entry with the UUID and group
Throws:
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:
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 repository
parentFolderId - the primary key of the folder's parent folder
name - the folder's name
Returns:
the folder with the name in the parent folder
Throws:
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 repository
parentFolderId - the primary key of the folder's parent folder
Returns:
the immediate subfolders of the parent folder
Throws:
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 repository
parentFolderId - the primary key of the folder's parent folder
includeMountFolders - whether to include mount folders for third-party repositories
Returns:
the immediate subfolders of the parent folder
Throws:
RemoteException

getFolders

public static FolderSoap[] getFolders(long repositoryId,
                                      long parentFolderId,
                                      boolean includeMountFolders,
                                      int start,
                                      int end)
                               throws RemoteException
Returns a name-ordered 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 repository
parentFolderId - the primary key of the folder's parent folder
includeMountFolders - whether to include mount folders for third-party repositories
start - the lower bound of the range of results
end - the upper bound of the range of results (not inclusive)
Returns:
the name-ordered range of immediate subfolders of the parent folder
Throws:
RemoteException

getFolders

public static FolderSoap[] getFolders(long repositoryId,
                                      long parentFolderId,
                                      boolean includeMountFolders,
                                      int start,
                                      int end,
                                      OrderByComparator<Folder> 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 repository
parentFolderId - the primary key of the folder's parent folder
includeMountFolders - whether to include mount folders for third-party repositories
start - the lower bound of the range of results
end - 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:
RemoteException

getFolders

public static FolderSoap[] getFolders(long repositoryId,
                                      long parentFolderId,
                                      int status,
                                      boolean includeMountFolders,
                                      int start,
                                      int end,
                                      OrderByComparator<Folder> 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 repository
parentFolderId - the primary key of the folder's parent folder
status - the workflow status
includeMountFolders - whether to include mount folders for third-party repositories
start - the lower bound of the range of results
end - 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:
RemoteException

getFolders

public static FolderSoap[] getFolders(long repositoryId,
                                      long parentFolderId,
                                      int start,
                                      int end)
                               throws RemoteException
Returns a name-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 repository
parentFolderId - the primary key of the folder's parent folder
start - the lower bound of the range of results
end - the upper bound of the range of results (not inclusive)
Returns:
the name-ordered range of immediate subfolders of the parent folder
Throws:
RemoteException

getFolders

public static FolderSoap[] getFolders(long repositoryId,
                                      long parentFolderId,
                                      int start,
                                      int end,
                                      OrderByComparator<Folder> 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 repository
parentFolderId - the primary key of the folder's parent folder
start - the lower bound of the range of results
end - 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:
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 repository
folderId - the primary key of the parent folder
status - the workflow status
includeMountFolders - 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:
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 repository
parentFolderId - the primary key of the folder's parent folder
Returns:
the number of immediate subfolders of the parent folder
Throws:
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 repository
parentFolderId - the primary key of the folder's parent folder
includeMountFolders - whether to include mount folders for third-party repositories
Returns:
the number of immediate subfolders of the parent folder
Throws:
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 repository
parentFolderId - the primary key of the folder's parent folder
status - the workflow status
includeMountFolders - whether to include mount folders for third-party repositories
Returns:
the number of immediate subfolders of the parent folder
Throws:
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 repository
folderIds - the primary keys of folders from which to count immediate subfolders and file entries
status - the workflow status
Returns:
the number of immediate subfolders and file entries across the folders
Throws:
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 group
userId - the primary key of the user who created the file (optionally 0)
start - the lower bound of the range of results
end - the upper bound of the range of results (not inclusive)
Returns:
the range of matching file entries ordered by date modified
Throws:
RemoteException

getGroupFileEntries

public static FileEntrySoap[] getGroupFileEntries(long groupId,
                                                  long userId,
                                                  int start,
                                                  int end,
                                                  OrderByComparator<FileEntry> 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 group
userId - the primary key of the user who created the file (optionally 0)
start - the lower bound of the range of results
end - 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:
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 group
userId - the primary key of the user who created the file (optionally 0)
rootFolderId - the primary key of the root folder to begin the search
start - the lower bound of the range of results
end - the upper bound of the range of results (not inclusive)
Returns:
the range of matching file entries ordered by date modified
Throws:
RemoteException

getGroupFileEntries

public static FileEntrySoap[] getGroupFileEntries(long groupId,
                                                  long userId,
                                                  long rootFolderId,
                                                  int start,
                                                  int end,
                                                  OrderByComparator<FileEntry> 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 group
userId - the primary key of the user who created the file (optionally 0)
rootFolderId - the primary key of the root folder to begin the search
start - the lower bound of the range of results
end - 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:
RemoteException

getGroupFileEntries

public static FileEntrySoap[] getGroupFileEntries(long groupId,
                                                  long userId,
                                                  long rootFolderId,
                                                  String[] mimeTypes,
                                                  int status,
                                                  int start,
                                                  int end,
                                                  OrderByComparator<FileEntry> 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 group
userId - the primary key of the user who created the file (optionally 0)
Returns:
the number of matching file entries
Throws:
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 group
userId - 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:
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 repository
parentFolderId - 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:
RemoteException

getMountFolders

public static FolderSoap[] getMountFolders(long repositoryId,
                                           long parentFolderId,
                                           int start,
                                           int end)
                                    throws RemoteException
Returns a name-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 repository
parentFolderId - the primary key of the parent folder
start - the lower bound of the range of results
end - the upper bound of the range of results (not inclusive)
Returns:
the name-ordered range of immediate subfolders of the parent folder that are used for mounting third-party repositories
Throws:
RemoteException

getMountFolders

public static FolderSoap[] getMountFolders(long repositoryId,
                                           long parentFolderId,
                                           int start,
                                           int end,
                                           OrderByComparator<Folder> 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 repository
parentFolderId - the primary key of the folder's parent folder
start - the lower bound of the range of results
end - 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:
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 repository
parentFolderId - 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:
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 repository
folderId - the primary key of the folder
Returns:
the descendant folders of the folder with the primary key
Throws:
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 repository
folderId - the primary key of the folder
recurse - whether to recurse through each subfolder
Returns:
the descendant folders of the folder with the primary key
Throws:
RemoteException

getTempFileNames

public static String[] getTempFileNames(long groupId,
                                        long folderId,
                                        String folderName)
                                 throws RemoteException
Returns all the temporary file entry names.

Parameters:
groupId - the primary key of the group
folderId - the primary key of the folder where the file entry will eventually reside
folderName - the temporary folder's name
Returns:
the temporary file entry names
Throws:
RemoteException
See Also:
#addTempFileEntry(long, long, String, String, File, String), TempFileEntryUtil

lockFolder

public static Lock lockFolder(long repositoryId,
                              long folderId)
                       throws RemoteException
Locks the folder. This method is primarily used by WebDAV.

Parameters:
repositoryId - the primary key of the repository
folderId - the primary key of the folder
Returns:
the lock object
Throws:
RemoteException

lockFolder

public static Lock lockFolder(long repositoryId,
                              long folderId,
                              String owner,
                              boolean inheritable,
                              long expirationTime)
                       throws RemoteException
Locks the folder. This method is primarily used by WebDAV.

Parameters:
repositoryId - the primary key of the repository
folderId - the primary key of the folder
owner - the owner string for the checkout (optionally null)
inheritable - whether the lock must propagate to descendants
expirationTime - the time in milliseconds before the lock expires. If the value is 0, the default expiration time will be used from portal.properties>.
Returns:
the lock object
Throws:
RemoteException

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 entry
newFolderId - the primary key of the new folder
serviceContext - the service context to be applied
Returns:
the file entry
Throws:
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 folder
parentFolderId - the primary key of the new parent folder
serviceContext - the service context to be applied
Returns:
the file entry
Throws:
RemoteException

refreshFileEntryLock

public static Lock refreshFileEntryLock(String lockUuid,
                                        long companyId,
                                        long expirationTime)
                                 throws RemoteException
Refreshes the lock for the file entry. This method is primarily used by WebDAV.

Parameters:
lockUuid - the lock's UUID
companyId - the primary key of the file entry's company
expirationTime - the time in milliseconds before the lock expires. If the value is 0, the default expiration time will be used from portal.properties>.
Returns:
the lock object
Throws:
RemoteException

refreshFolderLock

public static Lock refreshFolderLock(String lockUuid,
                                     long companyId,
                                     long expirationTime)
                              throws RemoteException
Refreshes the lock for the folder. This method is primarily used by WebDAV.

Parameters:
lockUuid - the lock's UUID
companyId - the primary key of the file entry's company
expirationTime - the time in milliseconds before the lock expires. If the value is 0, the default expiration time will be used from portal.properties>.
Returns:
the lock object
Throws:
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 entry
version - the version to revert back to
serviceContext - the service context to be applied
Throws:
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 group
fileEntryTypeId - the primary key of the file entry type
Throws:
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 group
folderId - the primary key of the folder
Throws:
RemoteException

unlockFileEntry

@Deprecated
public static void unlockFileEntry(long fileEntryId)
                            throws RemoteException
Deprecated. As of 6.2.0, replaced by checkInFileEntry(long, boolean, String, ServiceContext).

Throws:
RemoteException

unlockFileEntry

@Deprecated
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 repository
folderId - the primary key of the folder
lockUuid - the lock's UUID
Throws:
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 repository
parentFolderId - the primary key of the parent folder
name - the folder's name
lockUuid - the lock's UUID
Throws:
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 group
fileEntryTypeId - the primary key of the file entry type
Throws:
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 group
folderId - the primary key of the folder
Throws:
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 entry
sourceFileName - 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 description
changeLog - the file's version change log (optionally null)
majorVersion - whether the new file version is a major version
bytes - 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:
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 folder
name - the folder's new name
description - the folder's new description
serviceContext - 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
  • restrictionType - specifying restriction type 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:
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 repository
fileEntryId - the primary key for the file entry
lockUuid - the lock's UUID
Returns:
true if the file entry is checked out; false otherwise
Throws:
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 repository
folderId - the primary key for the folder
lockUuid - the lock's UUID
Returns:
true if the inheritable lock exists; false otherwise
Throws:
RemoteException

Liferay 7.0-ce-b4