DLAppServiceUtil (Liferay 7.4.3.23-ga23 portal-kernel API)

Object
- com.liferay.document.library.kernel.service.DLAppServiceUtil

```
public class DLAppServiceUtil
extends Object
```
Provides the remote service utility for DLApp. This utility wraps com.liferay.portlet.documentlibrary.service.impl.DLAppServiceImpl and is an access point for service operations in application layer code running on a remote server. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.

Author:

Brian Wing Shun Chan

See Also:

DLAppService

{$generated.description}

Constructor Summary

Constructors
Constructor and Description

DLAppServiceUtil()

Constructors
Constructor and Description
`DLAppServiceUtil()`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static FileEntry`	`addFileEntry(long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String description, String changeLog, File file, ServiceContext serviceContext)` Deprecated. As of Cavanaugh (7.4.x), replaced by `#addFileEntry(String, long, long, String, String, String, String, String, File, Date, Date, ServiceContext)`
`static FileEntry`	`addFileEntry(String externalReferenceCode, long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, byte[] bytes, Date expirationDate, Date reviewDate, ServiceContext serviceContext)` Adds a file entry and associated metadata.
`static FileEntry`	`addFileEntry(String externalReferenceCode, long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, File file, Date expirationDate, Date reviewDate, ServiceContext serviceContext)` Adds a file entry and associated metadata.
`static FileEntry`	`addFileEntry(String externalReferenceCode, long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, InputStream inputStream, long size, Date expirationDate, Date reviewDate, ServiceContext serviceContext)` Adds a file entry and associated metadata.
`static FileShortcut`	`addFileShortcut(long repositoryId, long folderId, long toFileEntryId, ServiceContext serviceContext)` Adds a file shortcut to the existing file entry.
`static Folder`	`addFolder(long repositoryId, long parentFolderId, String name, String description, ServiceContext serviceContext)` Adds a folder.
`static FileEntry`	`addTempFileEntry(long groupId, long folderId, String folderName, String fileName, File file, String mimeType)` Adds a temporary file entry.
`static FileEntry`	`addTempFileEntry(long groupId, long folderId, String folderName, String fileName, InputStream inputStream, String mimeType)` Adds a temporary file entry.
`static void`	`cancelCheckOut(long fileEntryId)` Cancels the check out of the file entry.
`static void`	`checkInFileEntry(long fileEntryId, DLVersionNumberIncrease dlVersionNumberIncrease, String changeLog, ServiceContext serviceContext)` Checks in the file entry.
`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 FileEntry`	`checkOutFileEntry(long fileEntryId, String owner, long expirationTime, ServiceContext serviceContext)` Checks out the file entry.
`static Folder`	`copyFolder(long repositoryId, long sourceFolderId, long parentFolderId, String name, String description, ServiceContext serviceContext)` Performs a deep copy of the folder.
`static void`	`deleteFileEntry(long fileEntryId)` Deletes the file entry with the primary key.
`static void`	`deleteFileEntryByTitle(long repositoryId, long folderId, String title)` Deletes the file entry with the title in the folder.
`static void`	`deleteFileShortcut(long fileShortcutId)` Deletes the file shortcut with the primary key.
`static void`	`deleteFileVersion(long fileVersionId)` Deletes the file version.
`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 List<FileEntry>`	`getFileEntries(long repositoryId, long folderId)` Returns all the file entries in the folder.
`static List<FileEntry>`	`getFileEntries(long repositoryId, long folderId, int start, int end)` Returns a name-ordered range of all the file entries in the folder.
`static List<FileEntry>`	`getFileEntries(long repositoryId, long folderId, int start, int end, OrderByComparator<FileEntry> orderByComparator)` Returns an ordered range of all the file entries in the folder.
`static List<FileEntry>`	`getFileEntries(long repositoryId, long folderId, long fileEntryTypeId)` Returns the file entries with the file entry type in the folder.
`static List<FileEntry>`	`getFileEntries(long repositoryId, long folderId, long fileEntryTypeId, int start, int end)` Returns a name-ordered range of all the file entries with the file entry type in the folder.
`static List<FileEntry>`	`getFileEntries(long repositoryId, long folderId, long fileEntryTypeId, int start, int end, OrderByComparator<FileEntry> orderByComparator)` Returns an ordered range of all the file entries with the file entry type in the folder.
`static List<FileEntry>`	`getFileEntries(long repositoryId, long folderId, String[] mimeTypes)`
`static List<FileEntry>`	`getFileEntries(long repositoryId, long folderId, String[] mimeTypes, int start, int end, OrderByComparator<FileEntry> orderByComparator)`
`static List<Object>`	`getFileEntriesAndFileShortcuts(long repositoryId, long folderId, int status, int start, int end)` Returns a range of all the file entries and shortcuts in the folder.
`static int`	`getFileEntriesAndFileShortcutsCount(long repositoryId, long folderId, int status)` Returns the number of file entries and shortcuts in the folder.
`static int`	`getFileEntriesAndFileShortcutsCount(long repositoryId, long folderId, int status, String[] mimeTypes)` Returns the number of file entries and shortcuts in the folder.
`static int`	`getFileEntriesCount(long repositoryId, long folderId)` Returns the number of file entries in the folder.
`static int`	`getFileEntriesCount(long repositoryId, long folderId, long fileEntryTypeId)` Returns the number of file entries with the file entry type in the folder.
`static int`	`getFileEntriesCount(long repositoryId, long folderId, String[] mimeTypes)`
`static FileEntry`	`getFileEntry(long fileEntryId)` Returns the file entry with the primary key.
`static FileEntry`	`getFileEntry(long groupId, long folderId, String title)` Returns the file entry with the title in the folder.
`static FileEntry`	`getFileEntryByExternalReferenceCode(long groupId, String externalReferenceCode)` Returns the file entry with the external reference code.
`static FileEntry`	`getFileEntryByFileName(long groupId, long folderId, String fileName)` Returns the file entry with the file name in the folder.
`static FileEntry`	`getFileEntryByUuidAndGroupId(String uuid, long groupId)` Returns the file entry with the UUID and group.
`static FileShortcut`	`getFileShortcut(long fileShortcutId)` Returns the file shortcut with the primary key.
`static FileVersion`	`getFileVersion(long fileVersionId)` Returns the file version with the primary key.
`static Folder`	`getFolder(long folderId)` Returns the folder with the primary key.
`static Folder`	`getFolder(long repositoryId, long parentFolderId, String name)` Returns the folder with the name in the parent folder.
`static List<Folder>`	`getFolders(long repositoryId, long parentFolderId)` Returns all immediate subfolders of the parent folder.
`static List<Folder>`	`getFolders(long repositoryId, long parentFolderId, boolean includeMountFolders)` Returns all immediate subfolders of the parent folder, optionally including mount folders for third-party repositories.
`static List<Folder>`	`getFolders(long repositoryId, long parentFolderId, boolean includeMountFolders, int start, int end)` Returns a name-ordered range of all the immediate subfolders of the parent folder, optionally including mount folders for third-party repositories.
`static List<Folder>`	`getFolders(long repositoryId, long parentFolderId, boolean includeMountFolders, int start, int end, OrderByComparator<Folder> orderByComparator)` Returns an ordered range of all the immediate subfolders of the parent folder.
`static List<Folder>`	`getFolders(long repositoryId, long parentFolderId, int status, boolean includeMountFolders, int start, int end, OrderByComparator<Folder> orderByComparator)` Returns an ordered range of all the immediate subfolders of the parent folder.
`static List<Folder>`	`getFolders(long repositoryId, long parentFolderId, int start, int end)` Returns a name-ordered range of all the immediate subfolders of the parent folder.
`static List<Folder>`	`getFolders(long repositoryId, long parentFolderId, int start, int end, OrderByComparator<Folder> orderByComparator)` Returns an ordered range of all the immediate subfolders of the parent folder.
`static List<Object>`	`getFoldersAndFileEntriesAndFileShortcuts(long repositoryId, long folderId, int status, boolean includeMountFolders, int start, int end)` Returns a name-ordered range of all the immediate subfolders, file entries, and file shortcuts in the parent folder.
`static List<Object>`	`getFoldersAndFileEntriesAndFileShortcuts(long repositoryId, long folderId, int status, boolean includeMountFolders, int start, int end, OrderByComparator<?> orderByComparator)` Returns an ordered range of all the immediate subfolders, file entries, and file shortcuts in the parent folder.
`static List<Object>`	`getFoldersAndFileEntriesAndFileShortcuts(long repositoryId, long folderId, int status, String[] mimeTypes, boolean includeMountFolders, boolean includeOwner, int start, int end, OrderByComparator<?> orderByComparator)`
`static List<Object>`	`getFoldersAndFileEntriesAndFileShortcuts(long repositoryId, long folderId, int status, String[] mimeTypes, boolean includeMountFolders, int start, int end, OrderByComparator<?> orderByComparator)`
`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`	`getFoldersAndFileEntriesAndFileShortcutsCount(long repositoryId, long folderId, int status, String[] mimeTypes, boolean includeMountFolders, boolean includeOwner)`
`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, List<Long> folderIds, int status)` Returns the number of immediate subfolders and file entries across the folders.
`static List<FileEntry>`	`getGroupFileEntries(long groupId, long userId, int start, int end)` Returns an ordered range of all the file entries in the group starting at the repository default parent folder that are stored within the Liferay repository.
`static List<FileEntry>`	`getGroupFileEntries(long groupId, long userId, int start, int end, OrderByComparator<FileEntry> orderByComparator)` Returns an ordered range of all the file entries in the group that are stored within the Liferay repository.
`static List<FileEntry>`	`getGroupFileEntries(long groupId, long userId, long rootFolderId, int start, int end)` Returns an ordered range of all the file entries in the group starting at the root folder that are stored within the Liferay repository.
`static List<FileEntry>`	`getGroupFileEntries(long groupId, long userId, long rootFolderId, int start, int end, OrderByComparator<FileEntry> orderByComparator)` Returns an ordered range of all the file entries in the group starting at the root folder that are stored within the Liferay repository.
`static List<FileEntry>`	`getGroupFileEntries(long groupId, long userId, long rootFolderId, String[] mimeTypes, int status, int start, int end, OrderByComparator<FileEntry> orderByComparator)`
`static int`	`getGroupFileEntriesCount(long groupId, long userId)` Returns the number of file entries in a group starting at the repository default parent folder that are stored within the Liferay repository.
`static int`	`getGroupFileEntriesCount(long groupId, long userId, long rootFolderId)` Returns the number of file entries in a group starting at the root folder that are stored within the Liferay repository.
`static int`	`getGroupFileEntriesCount(long groupId, long userId, long rootFolderId, String[] mimeTypes, int status)`
`static List<Folder>`	`getMountFolders(long repositoryId, long parentFolderId)` Returns all immediate subfolders of the parent folder that are used for mounting third-party repositories.
`static List<Folder>`	`getMountFolders(long repositoryId, long parentFolderId, int start, int end)` Returns a name-ordered range of all the immediate subfolders of the parent folder that are used for mounting third-party repositories.
`static List<Folder>`	`getMountFolders(long repositoryId, long parentFolderId, int start, int end, OrderByComparator<Folder> orderByComparator)` 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 String`	`getOSGiServiceIdentifier()` Returns the OSGi service identifier.
`static DLAppService`	`getService()`
`static void`	`getSubfolderIds(long repositoryId, List<Long> folderIds, long folderId)`
`static List<Long>`	`getSubfolderIds(long repositoryId, long folderId)` Returns all the descendant folders of the folder with the primary key.
`static List<Long>`	`getSubfolderIds(long repositoryId, long folderId, boolean recurse)` Returns descendant folders of the folder with the primary key, optionally limiting to one level deep.
`static String[]`	`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 FileEntry`	`moveFileEntry(long fileEntryId, long newFolderId, ServiceContext serviceContext)` Moves the file entry to the new folder.
`static Folder`	`moveFolder(long folderId, long parentFolderId, ServiceContext serviceContext)` Moves the folder to the new parent folder with the primary key.
`static Lock`	`refreshFileEntryLock(String lockUuid, long 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 Hits`	`search(long repositoryId, long creatorUserId, int status, int start, int end)`
`static Hits`	`search(long repositoryId, long creatorUserId, long folderId, String[] mimeTypes, int status, int start, int end)`
`static Hits`	`search(long repositoryId, SearchContext searchContext)`
`static Hits`	`search(long repositoryId, SearchContext searchContext, Query query)`
`static void`	`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`	`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 FileEntry`	`updateFileEntry(long fileEntryId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, byte[] bytes, Date expirationDate, Date reviewDate, ServiceContext serviceContext)` Updates a file entry and associated metadata based on a byte array object.
`static FileEntry`	`updateFileEntry(long fileEntryId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, File file, Date expirationDate, Date reviewDate, ServiceContext serviceContext)` Updates a file entry and associated metadata based on a `File` object.
`static FileEntry`	`updateFileEntry(long fileEntryId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, InputStream inputStream, long size, Date expirationDate, Date reviewDate, ServiceContext serviceContext)` Updates a file entry and associated metadata based on an `InputStream` object.
`static FileEntry`	`updateFileEntryAndCheckIn(long fileEntryId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, File file, Date expirationDate, Date reviewDate, ServiceContext serviceContext)`
`static FileEntry`	`updateFileEntryAndCheckIn(long fileEntryId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, InputStream inputStream, long size, Date expirationDate, Date reviewDate, ServiceContext serviceContext)`
`static FileShortcut`	`updateFileShortcut(long fileShortcutId, long folderId, long toFileEntryId, ServiceContext serviceContext)` Updates a file shortcut to the existing file entry.
`static Folder`	`updateFolder(long folderId, 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 Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DLAppServiceUtil
```
public DLAppServiceUtil()
```
- Method Detail
  - addFileEntry
```
@Deprecated
public static FileEntry addFileEntry(long repositoryId,
                                                 long folderId,
                                                 String sourceFileName,
                                                 String mimeType,
                                                 String title,
                                                 String description,
                                                 String changeLog,
                                                 File file,
                                                 ServiceContext serviceContext)
                                          throws PortalException
```
    Deprecated. As of Cavanaugh (7.4.x), replaced by #addFileEntry(String, long, long, String, String, String, String, String, File, Date, Date, ServiceContext)
    
    Adds a file entry and associated metadata. It is created based on a File object.
    This method takes two file names, the sourceFileName and the title. The sourceFileName corresponds to the name of the actual file being uploaded. The title corresponds to a name the client wishes to assign this file after it has been uploaded to the portal. If it is null, the sourceFileName will be used.
    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
    
    file - 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 a portal exception occurred
  - addFileEntry
```
public static FileEntry addFileEntry(String externalReferenceCode,
                                     long repositoryId,
                                     long folderId,
                                     String sourceFileName,
                                     String mimeType,
                                     String title,
                                     String urlTitle,
                                     String description,
                                     String changeLog,
                                     byte[] bytes,
                                     Date expirationDate,
                                     Date reviewDate,
                                     ServiceContext serviceContext)
                              throws PortalException
```
    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:
    
    externalReferenceCode - the file entry's external reference code
    
    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)
    
    urlTitle - the url title
    
    description - the file's description
    
    changeLog - the file's version change log
    
    bytes - the file's data (optionally null)
    
    expirationDate - the file's expiration date (optionally null)
    
    reviewDate - the file's review Date (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 a portal exception occurred
  - addFileEntry
```
public static FileEntry addFileEntry(String externalReferenceCode,
                                     long repositoryId,
                                     long folderId,
                                     String sourceFileName,
                                     String mimeType,
                                     String title,
                                     String urlTitle,
                                     String description,
                                     String changeLog,
                                     File file,
                                     Date expirationDate,
                                     Date reviewDate,
                                     ServiceContext serviceContext)
                              throws PortalException
```
    Adds a file entry and associated metadata. It is created based on a File object.
    This method takes two file names, the sourceFileName and the title. The sourceFileName corresponds to the name of the actual file being uploaded. The title corresponds to a name the client wishes to assign this file after it has been uploaded to the portal. If it is null, the sourceFileName will be used.
    Parameters:
    
    externalReferenceCode - the file entry's external reference code.
    
    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
    
    file - the file's data (optionally null)
    
    expirationDate - the file's expiration date (optionally null)
    
    reviewDate - the file's review Date (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 a portal exception occurred
  - addFileEntry
```
public static FileEntry addFileEntry(String externalReferenceCode,
                                     long repositoryId,
                                     long folderId,
                                     String sourceFileName,
                                     String mimeType,
                                     String title,
                                     String urlTitle,
                                     String description,
                                     String changeLog,
                                     InputStream inputStream,
                                     long size,
                                     Date expirationDate,
                                     Date reviewDate,
                                     ServiceContext serviceContext)
                              throws PortalException
```
    Adds a file entry and associated metadata. It is created based on a InputStream object.
    This method takes two file names, the sourceFileName and the title. The sourceFileName corresponds to the name of the actual file being uploaded. The title corresponds to a name the client wishes to assign this file after it has been uploaded to the portal. If it is null, the sourceFileName will be used.
    Parameters:
    
    externalReferenceCode - the file entry's external reference code.
    
    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
    
    inputStream - the file's data (optionally null)
    
    size - the file's size (optionally 0)
    
    expirationDate - the file's expiration date (optionally null)
    
    reviewDate - the file's review Date (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 a portal exception occurred
  - addFileShortcut
```
public static FileShortcut addFileShortcut(long repositoryId,
                                           long folderId,
                                           long toFileEntryId,
                                           ServiceContext serviceContext)
                                    throws PortalException
```
    Adds a file shortcut to the existing file entry. This method is only supported by the Liferay repository.
    
    Parameters:
    
    repositoryId - the primary key of the repository
    
    folderId - the primary key of the file shortcut's parent folder
    
    toFileEntryId - the primary key of the file shortcut's file entry
    
    serviceContext - 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 a portal exception occurred
  - addFolder
```
public static Folder addFolder(long repositoryId,
                               long parentFolderId,
                               String name,
                               String description,
                               ServiceContext serviceContext)
                        throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - addTempFileEntry
```
public static FileEntry addTempFileEntry(long groupId,
                                         long folderId,
                                         String folderName,
                                         String fileName,
                                         File file,
                                         String mimeType)
                                  throws PortalException
```
    Adds a temporary file entry.
    This allows a client to upload a file into a temporary location and manipulate its metadata prior to making it available for public usage. This is different from checking in and checking out a file entry.
    
    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
    
    fileName - the file's original name
    
    file - the file's data (optionally null)
    
    mimeType - the file's MIME type
    
    Returns:
    
    the temporary file entry
    
    Throws:
    
    PortalException - if a portal exception occurred
    
    See Also:
    
    TempFileEntryUtil
  - addTempFileEntry
```
public static FileEntry addTempFileEntry(long groupId,
                                         long folderId,
                                         String folderName,
                                         String fileName,
                                         InputStream inputStream,
                                         String mimeType)
                                  throws PortalException
```
    Adds a temporary file entry. It is created based on the InputStream object.
    This allows a client to upload a file into a temporary location and manipulate its metadata prior to making it available for public usage. This is different from checking in and checking out a file entry.
    
    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
    
    fileName - the file's original name
    
    inputStream - the file's data
    
    mimeType - the file's MIME type
    
    Returns:
    
    the temporary file entry
    
    Throws:
    
    PortalException - if a portal exception occurred
    
    See Also:
    
    TempFileEntryUtil
  - cancelCheckOut
```
public static void cancelCheckOut(long fileEntryId)
                           throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
    
    See Also:
    
    #checkInFileEntry(long, boolean, String, ServiceContext), checkOutFileEntry(long, ServiceContext)
  - checkInFileEntry
```
public static void checkInFileEntry(long fileEntryId,
                                    DLVersionNumberIncrease dlVersionNumberIncrease,
                                    String changeLog,
                                    ServiceContext serviceContext)
                             throws PortalException
```
    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
    
    dlVersionNumberIncrease - the kind of version number increase to apply for these changes.
    
    changeLog - the file's version change log
    
    serviceContext - the service context to be applied
    
    Throws:
    
    PortalException - if a portal exception occurred
    
    See Also:
    
    cancelCheckOut(long), checkOutFileEntry(long, ServiceContext)
  - checkInFileEntry
```
public static void checkInFileEntry(long fileEntryId,
                                    String lockUuid,
                                    ServiceContext serviceContext)
                             throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
    
    See Also:
    
    cancelCheckOut(long), checkOutFileEntry(long, String, long, ServiceContext)
  - checkOutFileEntry
```
public static void checkOutFileEntry(long fileEntryId,
                                     ServiceContext serviceContext)
                              throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
    
    See Also:
    
    cancelCheckOut(long), #checkInFileEntry(long, boolean, String, ServiceContext)
  - checkOutFileEntry
```
public static FileEntry checkOutFileEntry(long fileEntryId,
                                          String owner,
                                          long expirationTime,
                                          ServiceContext serviceContext)
                                   throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
    
    See Also:
    
    cancelCheckOut(long), #checkInFileEntry(long, String)
  - copyFolder
```
public static Folder copyFolder(long repositoryId,
                                long sourceFolderId,
                                long parentFolderId,
                                String name,
                                String description,
                                ServiceContext serviceContext)
                         throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - deleteFileEntry
```
public static void deleteFileEntry(long fileEntryId)
                            throws PortalException
```
    Deletes the file entry with the primary key.
    
    Parameters:
    
    fileEntryId - the primary key of the file entry
    
    Throws:
    
    PortalException - if a portal exception occurred
  - deleteFileEntryByTitle
```
public static void deleteFileEntryByTitle(long repositoryId,
                                          long folderId,
                                          String title)
                                   throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - deleteFileShortcut
```
public static void deleteFileShortcut(long fileShortcutId)
                               throws PortalException
```
    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 a portal exception occurred
  - deleteFileVersion
```
public static void deleteFileVersion(long fileVersionId)
                              throws PortalException
```
    Deletes the file version. File versions can only be deleted if it is approved and there are other approved file versions available.
    
    Parameters:
    
    fileVersionId - the primary key of the file version
    
    Throws:
    
    PortalException - if a portal exception occurred
  - deleteFileVersion
```
public static void deleteFileVersion(long fileEntryId,
                                     String version)
                              throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - deleteFolder
```
public static void deleteFolder(long folderId)
                         throws PortalException
```
    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 a portal exception occurred
  - deleteFolder
```
public static void deleteFolder(long repositoryId,
                                long parentFolderId,
                                String name)
                         throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - deleteTempFileEntry
```
public static void deleteTempFileEntry(long groupId,
                                       long folderId,
                                       String folderName,
                                       String fileName)
                                throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
    
    See Also:
    
    TempFileEntryUtil
  - getFileEntries
```
public static List<FileEntry> getFileEntries(long repositoryId,
                                             long folderId)
                                      throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - getFileEntries
```
public static List<FileEntry> getFileEntries(long repositoryId,
                                             long folderId,
                                             int start,
                                             int end)
                                      throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - getFileEntries
```
public static List<FileEntry> getFileEntries(long repositoryId,
                                             long folderId,
                                             int start,
                                             int end,
                                             OrderByComparator<FileEntry> orderByComparator)
                                      throws PortalException
```
    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)
    
    orderByComparator - the comparator to order the file entries (optionally null)
    
    Returns:
    
    the range of file entries in the folder ordered by comparator orderByComparator
    
    Throws:
    
    PortalException - if a portal exception occurred
  - getFileEntries
```
public static List<FileEntry> getFileEntries(long repositoryId,
                                             long folderId,
                                             long fileEntryTypeId)
                                      throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - getFileEntries
```
public static List<FileEntry> getFileEntries(long repositoryId,
                                             long folderId,
                                             long fileEntryTypeId,
                                             int start,
                                             int end)
                                      throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - getFileEntries
```
public static List<FileEntry> getFileEntries(long repositoryId,
                                             long folderId,
                                             long fileEntryTypeId,
                                             int start,
                                             int end,
                                             OrderByComparator<FileEntry> orderByComparator)
                                      throws PortalException
```
    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)
    
    orderByComparator - 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 a portal exception occurred
  - getFileEntries
```
public static List<FileEntry> getFileEntries(long repositoryId,
                                             long folderId,
                                             String[] mimeTypes)
                                      throws PortalException
```
    Throws:
    
    PortalException
  - getFileEntries
```
public static List<FileEntry> getFileEntries(long repositoryId,
                                             long folderId,
                                             String[] mimeTypes,
                                             int start,
                                             int end,
                                             OrderByComparator<FileEntry> orderByComparator)
                                      throws PortalException
```
    Throws:
    
    PortalException
  - getFileEntriesAndFileShortcuts
```
public static List<Object> getFileEntriesAndFileShortcuts(long repositoryId,
                                                          long folderId,
                                                          int status,
                                                          int start,
                                                          int end)
                                                   throws PortalException
```
    Returns a range of all the file entries and shortcuts in the folder.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.
    
    Parameters:
    
    repositoryId - the primary key of the repository
    
    folderId - the primary key of the folder
    
    status - the workflow status
    
    start - the lower bound of the range of results
    
    end - the upper bound of the range of results (not inclusive)
    
    Returns:
    
    the range of file entries and shortcuts in the folder
    
    Throws:
    
    PortalException - if a portal exception occurred
  - getFileEntriesAndFileShortcutsCount
```
public static int getFileEntriesAndFileShortcutsCount(long repositoryId,
                                                      long folderId,
                                                      int status)
                                               throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - getFileEntriesAndFileShortcutsCount
```
public static int getFileEntriesAndFileShortcutsCount(long repositoryId,
                                                      long folderId,
                                                      int status,
                                                      String[] mimeTypes)
                                               throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - getFileEntriesCount
```
public static int getFileEntriesCount(long repositoryId,
                                      long folderId)
                               throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - getFileEntriesCount
```
public static int getFileEntriesCount(long repositoryId,
                                      long folderId,
                                      long fileEntryTypeId)
                               throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - getFileEntriesCount
```
public static int getFileEntriesCount(long repositoryId,
                                      long folderId,
                                      String[] mimeTypes)
                               throws PortalException
```
    Throws:
    
    PortalException
  - getFileEntry
```
public static FileEntry getFileEntry(long fileEntryId)
                              throws PortalException
```
    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 a portal exception occurred
  - getFileEntry
```
public static FileEntry getFileEntry(long groupId,
                                     long folderId,
                                     String title)
                              throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - getFileEntryByExternalReferenceCode
```
public static FileEntry getFileEntryByExternalReferenceCode(long groupId,
                                                            String externalReferenceCode)
                                                     throws PortalException
```
    Returns the file entry with the external reference code.
    
    Parameters:
    
    groupId - the primary key of the file entry's group
    
    externalReferenceCode - the file entry's external reference code
    
    Returns:
    
    the file entry with the external reference code
    
    Throws:
    
    PortalException - if a portal exception occurred
  - getFileEntryByFileName
```
public static FileEntry getFileEntryByFileName(long groupId,
                                               long folderId,
                                               String fileName)
                                        throws PortalException
```
    Returns the file entry with the file name in the folder.
    
    Parameters:
    
    groupId - the primary key of the file entry's group
    
    folderId - the primary key of the file entry's folder
    
    fileName - the file entry's file name
    
    Returns:
    
    the file entry with the file name in the folder
    
    Throws:
    
    PortalException - if a portal exception occurred
  - getFileEntryByUuidAndGroupId
```
public static FileEntry getFileEntryByUuidAndGroupId(String uuid,
                                                     long groupId)
                                              throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - getFileShortcut
```
public static FileShortcut getFileShortcut(long fileShortcutId)
                                    throws PortalException
```
    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 a portal exception occurred
  - getFileVersion
```
public static FileVersion getFileVersion(long fileVersionId)
                                  throws PortalException
```
    Returns the file version with the primary key.
    
    Parameters:
    
    fileVersionId - the primary key of the file version
    
    Returns:
    
    the file version with the primary key
    
    Throws:
    
    PortalException - if a portal exception occurred
  - getFolder
```
public static Folder getFolder(long folderId)
                        throws PortalException
```
    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 a portal exception occurred
  - getFolder
```
public static Folder getFolder(long repositoryId,
                               long parentFolderId,
                               String name)
                        throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - getFolders
```
public static List<Folder> getFolders(long repositoryId,
                                      long parentFolderId)
                               throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - getFolders
```
public static List<Folder> getFolders(long repositoryId,
                                      long parentFolderId,
                                      boolean includeMountFolders)
                               throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - getFolders
```
public static List<Folder> getFolders(long repositoryId,
                                      long parentFolderId,
                                      boolean includeMountFolders,
                                      int start,
                                      int end)
                               throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - getFolders
```
public static List<Folder> getFolders(long repositoryId,
                                      long parentFolderId,
                                      boolean includeMountFolders,
                                      int start,
                                      int end,
                                      OrderByComparator<Folder> orderByComparator)
                               throws PortalException
```
    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)
    
    orderByComparator - the comparator to order the folders (optionally null)
    
    Returns:
    
    the range of immediate subfolders of the parent folder ordered by comparator orderByComparator
    
    Throws:
    
    PortalException - if a portal exception occurred
  - getFolders
```
public static List<Folder> getFolders(long repositoryId,
                                      long parentFolderId,
                                      int status,
                                      boolean includeMountFolders,
                                      int start,
                                      int end,
                                      OrderByComparator<Folder> orderByComparator)
                               throws PortalException
```
    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)
    
    orderByComparator - the comparator to order the folders (optionally null)
    
    Returns:
    
    the range of immediate subfolders of the parent folder ordered by comparator orderByComparator
    
    Throws:
    
    PortalException - if a portal exception occurred
  - getFolders
```
public static List<Folder> getFolders(long repositoryId,
                                      long parentFolderId,
                                      int start,
                                      int end)
                               throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - getFolders
```
public static List<Folder> getFolders(long repositoryId,
                                      long parentFolderId,
                                      int start,
                                      int end,
                                      OrderByComparator<Folder> orderByComparator)
                               throws PortalException
```
    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)
    
    orderByComparator - the comparator to order the folders (optionally null)
    
    Returns:
    
    the range of immediate subfolders of the parent folder ordered by comparator orderByComparator
    
    Throws:
    
    PortalException - if a portal exception occurred
  - getFoldersAndFileEntriesAndFileShortcuts
```
public static List<Object> getFoldersAndFileEntriesAndFileShortcuts(long repositoryId,
                                                                    long folderId,
                                                                    int status,
                                                                    boolean includeMountFolders,
                                                                    int start,
                                                                    int end)
                                                             throws PortalException
```
    Returns a name-ordered range of all the immediate subfolders, file entries, and file shortcuts in the parent folder.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.
    
    Parameters:
    
    repositoryId - the primary key of the repository
    
    folderId - the primary key of the 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)
    
    Returns:
    
    the name-ordered range of immediate subfolders, file entries, and file shortcuts in the parent folder
    
    Throws:
    
    PortalException - if a portal exception occurred
  - getFoldersAndFileEntriesAndFileShortcuts
```
public static List<Object> getFoldersAndFileEntriesAndFileShortcuts(long repositoryId,
                                                                    long folderId,
                                                                    int status,
                                                                    boolean includeMountFolders,
                                                                    int start,
                                                                    int end,
                                                                    OrderByComparator<?> orderByComparator)
                                                             throws PortalException
```
    Returns an ordered range of all the immediate subfolders, file entries, and file shortcuts in the parent folder.
    Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.
    
    Parameters:
    
    repositoryId - the primary key of the repository
    
    folderId - the primary key of the 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)
    
    orderByComparator - the comparator to order the results (optionally null)
    
    Returns:
    
    the range of immediate subfolders, file entries, and file shortcuts in the parent folder ordered by comparator orderByComparator
    
    Throws:
    
    PortalException - if a portal exception occurred
  - getFoldersAndFileEntriesAndFileShortcuts
```
public static List<Object> getFoldersAndFileEntriesAndFileShortcuts(long repositoryId,
                                                                    long folderId,
                                                                    int status,
                                                                    String[] mimeTypes,
                                                                    boolean includeMountFolders,
                                                                    boolean includeOwner,
                                                                    int start,
                                                                    int end,
                                                                    OrderByComparator<?> orderByComparator)
                                                             throws PortalException
```
    Throws:
    
    PortalException
  - getFoldersAndFileEntriesAndFileShortcuts
```
public static List<Object> getFoldersAndFileEntriesAndFileShortcuts(long repositoryId,
                                                                    long folderId,
                                                                    int status,
                                                                    String[] mimeTypes,
                                                                    boolean includeMountFolders,
                                                                    int start,
                                                                    int end,
                                                                    OrderByComparator<?> orderByComparator)
                                                             throws PortalException
```
    Throws:
    
    PortalException
  - getFoldersAndFileEntriesAndFileShortcutsCount
```
public static int getFoldersAndFileEntriesAndFileShortcutsCount(long repositoryId,
                                                                long folderId,
                                                                int status,
                                                                boolean includeMountFolders)
                                                         throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - getFoldersAndFileEntriesAndFileShortcutsCount
```
public static int getFoldersAndFileEntriesAndFileShortcutsCount(long repositoryId,
                                                                long folderId,
                                                                int status,
                                                                String[] mimeTypes,
                                                                boolean includeMountFolders)
                                                         throws PortalException
```
    Throws:
    
    PortalException
  - getFoldersAndFileEntriesAndFileShortcutsCount
```
public static int getFoldersAndFileEntriesAndFileShortcutsCount(long repositoryId,
                                                                long folderId,
                                                                int status,
                                                                String[] mimeTypes,
                                                                boolean includeMountFolders,
                                                                boolean includeOwner)
                                                         throws PortalException
```
    Throws:
    
    PortalException
  - getFoldersCount
```
public static int getFoldersCount(long repositoryId,
                                  long parentFolderId)
                           throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - getFoldersCount
```
public static int getFoldersCount(long repositoryId,
                                  long parentFolderId,
                                  boolean includeMountFolders)
                           throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - getFoldersCount
```
public static int getFoldersCount(long repositoryId,
                                  long parentFolderId,
                                  int status,
                                  boolean includeMountFolders)
                           throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - getFoldersFileEntriesCount
```
public static int getFoldersFileEntriesCount(long repositoryId,
                                             List<Long> folderIds,
                                             int status)
                                      throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - getGroupFileEntries
```
public static List<FileEntry> getGroupFileEntries(long groupId,
                                                  long userId,
                                                  int start,
                                                  int end)
                                           throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - getGroupFileEntries
```
public static List<FileEntry> getGroupFileEntries(long groupId,
                                                  long userId,
                                                  int start,
                                                  int end,
                                                  OrderByComparator<FileEntry> orderByComparator)
                                           throws PortalException
```
    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)
    
    orderByComparator - the comparator to order the file entries (optionally null)
    
    Returns:
    
    the range of matching file entries ordered by comparator orderByComparator
    
    Throws:
    
    PortalException - if a portal exception occurred
  - getGroupFileEntries
```
public static List<FileEntry> getGroupFileEntries(long groupId,
                                                  long userId,
                                                  long rootFolderId,
                                                  int start,
                                                  int end)
                                           throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - getGroupFileEntries
```
public static List<FileEntry> getGroupFileEntries(long groupId,
                                                  long userId,
                                                  long rootFolderId,
                                                  int start,
                                                  int end,
                                                  OrderByComparator<FileEntry> orderByComparator)
                                           throws PortalException
```
    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)
    
    orderByComparator - the comparator to order the file entries (optionally null)
    
    Returns:
    
    the range of matching file entries ordered by comparator orderByComparator
    
    Throws:
    
    PortalException - if a portal exception occurred
  - getGroupFileEntries
```
public static List<FileEntry> getGroupFileEntries(long groupId,
                                                  long userId,
                                                  long rootFolderId,
                                                  String[] mimeTypes,
                                                  int status,
                                                  int start,
                                                  int end,
                                                  OrderByComparator<FileEntry> orderByComparator)
                                           throws PortalException
```
    Throws:
    
    PortalException
  - getGroupFileEntriesCount
```
public static int getGroupFileEntriesCount(long groupId,
                                           long userId)
                                    throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - getGroupFileEntriesCount
```
public static int getGroupFileEntriesCount(long groupId,
                                           long userId,
                                           long rootFolderId)
                                    throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - getGroupFileEntriesCount
```
public static int getGroupFileEntriesCount(long groupId,
                                           long userId,
                                           long rootFolderId,
                                           String[] mimeTypes,
                                           int status)
                                    throws PortalException
```
    Throws:
    
    PortalException
  - getMountFolders
```
public static List<Folder> getMountFolders(long repositoryId,
                                           long parentFolderId)
                                    throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - getMountFolders
```
public static List<Folder> getMountFolders(long repositoryId,
                                           long parentFolderId,
                                           int start,
                                           int end)
                                    throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - getMountFolders
```
public static List<Folder> getMountFolders(long repositoryId,
                                           long parentFolderId,
                                           int start,
                                           int end,
                                           OrderByComparator<Folder> orderByComparator)
                                    throws PortalException
```
    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)
    
    orderByComparator - 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 orderByComparator
    
    Throws:
    
    PortalException - if a portal exception occurred
  - getMountFoldersCount
```
public static int getMountFoldersCount(long repositoryId,
                                       long parentFolderId)
                                throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - getOSGiServiceIdentifier
```
public static String getOSGiServiceIdentifier()
```
    Returns the OSGi service identifier.
    
    Returns:
    
    the OSGi service identifier
  - getSubfolderIds
```
public static void getSubfolderIds(long repositoryId,
                                   List<Long> folderIds,
                                   long folderId)
                            throws PortalException
```
    Throws:
    
    PortalException
  - getSubfolderIds
```
public static List<Long> getSubfolderIds(long repositoryId,
                                         long folderId)
                                  throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - getSubfolderIds
```
public static List<Long> getSubfolderIds(long repositoryId,
                                         long folderId,
                                         boolean recurse)
                                  throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - getTempFileNames
```
public static String[] getTempFileNames(long groupId,
                                        long folderId,
                                        String folderName)
                                 throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
    
    See Also:
    
    addTempFileEntry(long, long, String, String, File, String), TempFileEntryUtil
  - lockFolder
```
public static Lock lockFolder(long repositoryId,
                              long folderId)
                       throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - lockFolder
```
public static Lock lockFolder(long repositoryId,
                              long folderId,
                              String owner,
                              boolean inheritable,
                              long expirationTime)
                       throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - moveFileEntry
```
public static FileEntry moveFileEntry(long fileEntryId,
                                      long newFolderId,
                                      ServiceContext serviceContext)
                               throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - moveFolder
```
public static Folder moveFolder(long folderId,
                                long parentFolderId,
                                ServiceContext serviceContext)
                         throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - refreshFileEntryLock
```
public static Lock refreshFileEntryLock(String lockUuid,
                                        long companyId,
                                        long expirationTime)
                                 throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - refreshFolderLock
```
public static Lock refreshFolderLock(String lockUuid,
                                     long companyId,
                                     long expirationTime)
                              throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - revertFileEntry
```
public static void revertFileEntry(long fileEntryId,
                                   String version,
                                   ServiceContext serviceContext)
                            throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - search
```
public static Hits search(long repositoryId,
                          long creatorUserId,
                          int status,
                          int start,
                          int end)
                   throws PortalException
```
    Throws:
    
    PortalException
  - search
```
public static Hits search(long repositoryId,
                          long creatorUserId,
                          long folderId,
                          String[] mimeTypes,
                          int status,
                          int start,
                          int end)
                   throws PortalException
```
    Throws:
    
    PortalException
  - search
```
public static Hits search(long repositoryId,
                          SearchContext searchContext)
                   throws SearchException
```
    Throws:
    
    SearchException
  - search
```
public static Hits search(long repositoryId,
                          SearchContext searchContext,
                          Query query)
                   throws SearchException
```
    Throws:
    
    SearchException
  - subscribeFileEntryType
```
public static void subscribeFileEntryType(long groupId,
                                          long fileEntryTypeId)
                                   throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - subscribeFolder
```
public static void subscribeFolder(long groupId,
                                   long folderId)
                            throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - unlockFolder
```
public static void unlockFolder(long repositoryId,
                                long folderId,
                                String lockUuid)
                         throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - unlockFolder
```
public static void unlockFolder(long repositoryId,
                                long parentFolderId,
                                String name,
                                String lockUuid)
                         throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - unsubscribeFileEntryType
```
public static void unsubscribeFileEntryType(long groupId,
                                            long fileEntryTypeId)
                                     throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - unsubscribeFolder
```
public static void unsubscribeFolder(long groupId,
                                     long folderId)
                              throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - updateFileEntry
```
public static FileEntry updateFileEntry(long fileEntryId,
                                        String sourceFileName,
                                        String mimeType,
                                        String title,
                                        String urlTitle,
                                        String description,
                                        String changeLog,
                                        DLVersionNumberIncrease dlVersionNumberIncrease,
                                        byte[] bytes,
                                        Date expirationDate,
                                        Date reviewDate,
                                        ServiceContext serviceContext)
                                 throws PortalException
```
    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)
    
    dlVersionNumberIncrease - the kind of version number increase to apply for these changes.
    
    bytes - the file's data (optionally null)
    
    expirationDate - the file's expiration date (optionally null)
    
    reviewDate - the file's review date (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 a portal exception occurred
  - updateFileEntry
```
public static FileEntry updateFileEntry(long fileEntryId,
                                        String sourceFileName,
                                        String mimeType,
                                        String title,
                                        String urlTitle,
                                        String description,
                                        String changeLog,
                                        DLVersionNumberIncrease dlVersionNumberIncrease,
                                        File file,
                                        Date expirationDate,
                                        Date reviewDate,
                                        ServiceContext serviceContext)
                                 throws PortalException
```
    Updates a file entry and associated metadata based on a File object. If the file data is null, then only the associated metadata (i.e., title, description, and parameters in the serviceContext) will be updated.
    This method takes two file names, the sourceFileName and the title. The sourceFileName corresponds to the name of the actual file being uploaded. The title corresponds to a name the client wishes to assign this file after it has been uploaded to the portal.
    Parameters:
    
    fileEntryId - the primary key of the file 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)
    
    dlVersionNumberIncrease - the kind of version number increase to apply for these changes.
    
    file - the file's data (optionally null)
    
    expirationDate - the file's expiration date (optionally null)
    
    reviewDate - the file's review date (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 a portal exception occurred
  - updateFileEntry
```
public static FileEntry updateFileEntry(long fileEntryId,
                                        String sourceFileName,
                                        String mimeType,
                                        String title,
                                        String urlTitle,
                                        String description,
                                        String changeLog,
                                        DLVersionNumberIncrease dlVersionNumberIncrease,
                                        InputStream inputStream,
                                        long size,
                                        Date expirationDate,
                                        Date reviewDate,
                                        ServiceContext serviceContext)
                                 throws PortalException
```
    Updates a file entry and associated metadata based on an InputStream object. If the file data is null, then only the associated metadata (i.e., title, description, and parameters in the serviceContext) will be updated.
    This method takes two file names, the sourceFileName and the title. The sourceFileName corresponds to the name of the actual file being uploaded. The title corresponds to a name the client wishes to assign this file after it has been uploaded to the portal.
    Parameters:
    
    fileEntryId - the primary key of the file 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)
    
    dlVersionNumberIncrease - the kind of version number increase to apply for these changes.
    
    inputStream - the file's data (optionally null)
    
    size - the file's size (optionally 0)
    
    expirationDate - the file's expiration date (optionally null)
    
    reviewDate - the file's review date (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 a portal exception occurred
  - updateFileEntryAndCheckIn
```
public static FileEntry updateFileEntryAndCheckIn(long fileEntryId,
                                                  String sourceFileName,
                                                  String mimeType,
                                                  String title,
                                                  String urlTitle,
                                                  String description,
                                                  String changeLog,
                                                  DLVersionNumberIncrease dlVersionNumberIncrease,
                                                  File file,
                                                  Date expirationDate,
                                                  Date reviewDate,
                                                  ServiceContext serviceContext)
                                           throws PortalException
```
    Throws:
    
    PortalException
  - updateFileEntryAndCheckIn
```
public static FileEntry updateFileEntryAndCheckIn(long fileEntryId,
                                                  String sourceFileName,
                                                  String mimeType,
                                                  String title,
                                                  String urlTitle,
                                                  String description,
                                                  String changeLog,
                                                  DLVersionNumberIncrease dlVersionNumberIncrease,
                                                  InputStream inputStream,
                                                  long size,
                                                  Date expirationDate,
                                                  Date reviewDate,
                                                  ServiceContext serviceContext)
                                           throws PortalException
```
    Throws:
    
    PortalException
  - updateFileShortcut
```
public static FileShortcut updateFileShortcut(long fileShortcutId,
                                              long folderId,
                                              long toFileEntryId,
                                              ServiceContext serviceContext)
                                       throws PortalException
```
    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 shortcut
    
    folderId - the primary key of the file shortcut's parent folder
    
    toFileEntryId - the primary key of the file shortcut's file entry
    
    serviceContext - 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 a portal exception occurred
  - updateFolder
```
public static Folder updateFolder(long folderId,
                                  String name,
                                  String description,
                                  ServiceContext serviceContext)
                           throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - verifyFileEntryCheckOut
```
public static boolean verifyFileEntryCheckOut(long repositoryId,
                                              long fileEntryId,
                                              String lockUuid)
                                       throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - verifyFileEntryLock
```
public static boolean verifyFileEntryLock(long repositoryId,
                                          long fileEntryId,
                                          String lockUuid)
                                   throws PortalException
```
    Throws:
    
    PortalException
  - verifyInheritableLock
```
public static boolean verifyInheritableLock(long repositoryId,
                                            long folderId,
                                            String lockUuid)
                                     throws PortalException
```
    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:
    
    PortalException - if a portal exception occurred
  - getService
```
public static DLAppService getService()
```

Class DLAppServiceUtil

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

DLAppServiceUtil

Method Detail

addFileEntry

addFileEntry

addFileEntry

addFileEntry

addFileShortcut

addFolder

addTempFileEntry

addTempFileEntry

cancelCheckOut

checkInFileEntry

checkInFileEntry

checkOutFileEntry

checkOutFileEntry

copyFolder

deleteFileEntry

deleteFileEntryByTitle

deleteFileShortcut

deleteFileVersion

deleteFileVersion

deleteFolder

deleteFolder

deleteTempFileEntry

getFileEntries

getFileEntries

getFileEntries

getFileEntries

getFileEntries

getFileEntries

getFileEntries

getFileEntries

getFileEntriesAndFileShortcuts

getFileEntriesAndFileShortcutsCount

getFileEntriesAndFileShortcutsCount

getFileEntriesCount

getFileEntriesCount

getFileEntriesCount

getFileEntry

getFileEntry

getFileEntryByExternalReferenceCode

getFileEntryByFileName

getFileEntryByUuidAndGroupId

getFileShortcut

getFileVersion

getFolder

getFolder

getFolders

getFolders

getFolders

getFolders

getFolders

getFolders

getFolders

getFoldersAndFileEntriesAndFileShortcuts

getFoldersAndFileEntriesAndFileShortcuts

getFoldersAndFileEntriesAndFileShortcuts

getFoldersAndFileEntriesAndFileShortcuts

getFoldersAndFileEntriesAndFileShortcutsCount

getFoldersAndFileEntriesAndFileShortcutsCount

getFoldersAndFileEntriesAndFileShortcutsCount

getFoldersCount

getFoldersCount

getFoldersCount

getFoldersFileEntriesCount

getGroupFileEntries

getGroupFileEntries

getGroupFileEntries

getGroupFileEntries

getGroupFileEntries

getGroupFileEntriesCount

getGroupFileEntriesCount

getGroupFileEntriesCount

getMountFolders

getMountFolders