DLAppService (Liferay 7.1.1-ga2 portal-kernel API)

All Superinterfaces:

BaseService

All Known Implementing Classes:

DLAppServiceWrapper
```
@AccessControlled
 @JSONWebService
 @ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface DLAppService
extends BaseService
```
Provides the remote service interface for DLApp. 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:

DLAppServiceUtil, DLAppServiceBaseImpl, DLAppServiceImpl

{$generated.description}

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`FileEntry`	`addFileEntry(long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String description, String changeLog, byte[] bytes, ServiceContext serviceContext)` Adds a file entry and associated metadata.
`FileEntry`	`addFileEntry(long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String description, String changeLog, File file, ServiceContext serviceContext)` Adds a file entry and associated metadata.
`FileEntry`	`addFileEntry(long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String description, String changeLog, InputStream is, long size, ServiceContext serviceContext)` Adds a file entry and associated metadata.
`FileShortcut`	`addFileShortcut(long repositoryId, long folderId, long toFileEntryId, ServiceContext serviceContext)` Adds a file shortcut to the existing file entry.
`Folder`	`addFolder(long repositoryId, long parentFolderId, String name, String description, ServiceContext serviceContext)` Adds a folder.
`FileEntry`	`addTempFileEntry(long groupId, long folderId, String folderName, String fileName, File file, String mimeType)` Adds a temporary file entry.
`FileEntry`	`addTempFileEntry(long groupId, long folderId, String folderName, String fileName, InputStream inputStream, String mimeType)` Adds a temporary file entry.
`void`	`cancelCheckOut(long fileEntryId)` Cancels the check out of the file entry.
`void`	`checkInFileEntry(long fileEntryId, boolean majorVersion, String changeLog, ServiceContext serviceContext)` Checks in the file entry.
`void`	`checkInFileEntry(long fileEntryId, String lockUuid, ServiceContext serviceContext)` Checks in the file entry using the lock's UUID.
`void`	`checkOutFileEntry(long fileEntryId, ServiceContext serviceContext)` Check out a file entry.
`FileEntry`	`checkOutFileEntry(long fileEntryId, String owner, long expirationTime, ServiceContext serviceContext)` Checks out the file entry.
`Folder`	`copyFolder(long repositoryId, long sourceFolderId, long parentFolderId, String name, String description, ServiceContext serviceContext)` Performs a deep copy of the folder.
`void`	`deleteFileEntry(long fileEntryId)` Deletes the file entry with the primary key.
`void`	`deleteFileEntryByTitle(long repositoryId, long folderId, String title)` Deletes the file entry with the title in the folder.
`void`	`deleteFileShortcut(long fileShortcutId)` Deletes the file shortcut with the primary key.
`void`	`deleteFileVersion(long fileEntryId, String version)` Deletes the file version.
`void`	`deleteFolder(long folderId)` Deletes the folder with the primary key and all of its subfolders and file entries.
`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.
`void`	`deleteTempFileEntry(long groupId, long folderId, String folderName, String fileName)` Deletes the temporary file entry.
`List<FileEntry>`	`getFileEntries(long repositoryId, long folderId)` Returns all the file entries in the folder.
`List<FileEntry>`	`getFileEntries(long repositoryId, long folderId, int start, int end)` Returns a name-ordered range of all the file entries in the folder.
`List<FileEntry>`	`getFileEntries(long repositoryId, long folderId, int start, int end, OrderByComparator<FileEntry> obc)` Returns an ordered range of all the file entries in the folder.
`List<FileEntry>`	`getFileEntries(long repositoryId, long folderId, long fileEntryTypeId)` Returns the file entries with the file entry type in the folder.
`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.
`List<FileEntry>`	`getFileEntries(long repositoryId, long folderId, long fileEntryTypeId, int start, int end, OrderByComparator<FileEntry> obc)` Returns an ordered range of all the file entries with the file entry type in the folder.
`List<FileEntry>`	`getFileEntries(long repositoryId, long folderId, String[] mimeTypes)`
`List<FileEntry>`	`getFileEntries(long repositoryId, long folderId, String[] mimeTypes, int start, int end, OrderByComparator<FileEntry> obc)`
`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.
`int`	`getFileEntriesAndFileShortcutsCount(long repositoryId, long folderId, int status)` Returns the number of file entries and shortcuts in the folder.
`int`	`getFileEntriesAndFileShortcutsCount(long repositoryId, long folderId, int status, String[] mimeTypes)` Returns the number of file entries and shortcuts in the folder.
`int`	`getFileEntriesCount(long repositoryId, long folderId)` Returns the number of file entries in the folder.
`int`	`getFileEntriesCount(long repositoryId, long folderId, long fileEntryTypeId)` Returns the number of file entries with the file entry type in the folder.
`int`	`getFileEntriesCount(long repositoryId, long folderId, String[] mimeTypes)`
`FileEntry`	`getFileEntry(long fileEntryId)` Returns the file entry with the primary key.
`FileEntry`	`getFileEntry(long groupId, long folderId, String title)` Returns the file entry with the title in the folder.
`FileEntry`	`getFileEntryByUuidAndGroupId(String uuid, long groupId)` Returns the file entry with the UUID and group.
`FileShortcut`	`getFileShortcut(long fileShortcutId)` Returns the file shortcut with the primary key.
`FileVersion`	`getFileVersion(long fileVersionId)` Returns the file version with the primary key.
`Folder`	`getFolder(long folderId)` Returns the folder with the primary key.
`Folder`	`getFolder(long repositoryId, long parentFolderId, String name)` Returns the folder with the name in the parent folder.
`List<Folder>`	`getFolders(long repositoryId, long parentFolderId)` Returns all immediate subfolders of the parent folder.
`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.
`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.
`List<Folder>`	`getFolders(long repositoryId, long parentFolderId, boolean includeMountFolders, int start, int end, OrderByComparator<Folder> obc)` Returns an ordered range of all the immediate subfolders of the parent folder.
`List<Folder>`	`getFolders(long repositoryId, long parentFolderId, int status, boolean includeMountFolders, int start, int end, OrderByComparator<Folder> obc)` Returns an ordered range of all the immediate subfolders of the parent folder.
`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.
`List<Folder>`	`getFolders(long repositoryId, long parentFolderId, int start, int end, OrderByComparator<Folder> obc)` Returns an ordered range of all the immediate subfolders of the parent folder.
`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.
`List<Object>`	`getFoldersAndFileEntriesAndFileShortcuts(long repositoryId, long folderId, int status, boolean includeMountFolders, int start, int end, OrderByComparator<?> obc)` Returns an ordered range of all the immediate subfolders, file entries, and file shortcuts in the parent folder.
`List<Object>`	`getFoldersAndFileEntriesAndFileShortcuts(long repositoryId, long folderId, int status, String[] mimeTypes, boolean includeMountFolders, boolean includeOwner, int start, int end, OrderByComparator<?> obc)`
`List<Object>`	`getFoldersAndFileEntriesAndFileShortcuts(long repositoryId, long folderId, int status, String[] mimeTypes, boolean includeMountFolders, int start, int end, OrderByComparator<?> obc)`
`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.
`int`	`getFoldersAndFileEntriesAndFileShortcutsCount(long repositoryId, long folderId, int status, String[] mimeTypes, boolean includeMountFolders)`
`int`	`getFoldersAndFileEntriesAndFileShortcutsCount(long repositoryId, long folderId, int status, String[] mimeTypes, boolean includeMountFolders, boolean includeOwner)`
`int`	`getFoldersCount(long repositoryId, long parentFolderId)` Returns the number of immediate subfolders of the parent folder.
`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.
`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.
`int`	`getFoldersFileEntriesCount(long repositoryId, List<Long> folderIds, int status)` Returns the number of immediate subfolders and file entries across the folders.
`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.
`List<FileEntry>`	`getGroupFileEntries(long groupId, long userId, int start, int end, OrderByComparator<FileEntry> obc)` Returns an ordered range of all the file entries in the group that are stored within the Liferay repository.
`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.
`List<FileEntry>`	`getGroupFileEntries(long groupId, long userId, long rootFolderId, int start, int end, OrderByComparator<FileEntry> obc)` Returns an ordered range of all the file entries in the group starting at the root folder that are stored within the Liferay repository.
`List<FileEntry>`	`getGroupFileEntries(long groupId, long userId, long rootFolderId, String[] mimeTypes, int status, int start, int end, OrderByComparator<FileEntry> obc)`
`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.
`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.
`int`	`getGroupFileEntriesCount(long groupId, long userId, long rootFolderId, String[] mimeTypes, int status)`
`List<Folder>`	`getMountFolders(long repositoryId, long parentFolderId)` Returns all immediate subfolders of the parent folder that are used for mounting third-party repositories.
`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.
`List<Folder>`	`getMountFolders(long repositoryId, long parentFolderId, int start, int end, OrderByComparator<Folder> obc)` Returns an ordered range of all the immediate subfolders of the parent folder that are used for mounting third-party repositories.
`int`	`getMountFoldersCount(long repositoryId, long parentFolderId)` Returns the number of immediate subfolders of the parent folder that are used for mounting third-party repositories.
`String`	`getOSGiServiceIdentifier()` Returns the OSGi service identifier.
`void`	`getSubfolderIds(long repositoryId, List<Long> folderIds, long folderId)`
`List<Long>`	`getSubfolderIds(long repositoryId, long folderId)` Returns all the descendant folders of the folder with the primary key.
`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.
`String[]`	`getTempFileNames(long groupId, long folderId, String folderName)` Returns all the temporary file entry names.
`Lock`	`lockFolder(long repositoryId, long folderId)` Locks the folder.
`Lock`	`lockFolder(long repositoryId, long folderId, String owner, boolean inheritable, long expirationTime)` Locks the folder.
`FileEntry`	`moveFileEntry(long fileEntryId, long newFolderId, ServiceContext serviceContext)` Moves the file entry to the new folder.
`Folder`	`moveFolder(long folderId, long parentFolderId, ServiceContext serviceContext)` Moves the folder to the new parent folder with the primary key.
`Lock`	`refreshFileEntryLock(String lockUuid, long companyId, long expirationTime)` Refreshes the lock for the file entry.
`Lock`	`refreshFolderLock(String lockUuid, long companyId, long expirationTime)` Refreshes the lock for the folder.
`void`	`revertFileEntry(long fileEntryId, String version, ServiceContext serviceContext)` Reverts the file entry to a previous version.
`Hits`	`search(long repositoryId, long creatorUserId, int status, int start, int end)`
`Hits`	`search(long repositoryId, long creatorUserId, long folderId, String[] mimeTypes, int status, int start, int end)`
`Hits`	`search(long repositoryId, SearchContext searchContext)`
`Hits`	`search(long repositoryId, SearchContext searchContext, Query query)`
`void`	`subscribeFileEntryType(long groupId, long fileEntryTypeId)` Subscribe the user to changes in documents of the file entry type.
`void`	`subscribeFolder(long groupId, long folderId)` Subscribe the user to document changes in the folder.
`void`	`unlockFolder(long repositoryId, long folderId, String lockUuid)` Unlocks the folder.
`void`	`unlockFolder(long repositoryId, long parentFolderId, String name, String lockUuid)` Unlocks the folder.
`void`	`unsubscribeFileEntryType(long groupId, long fileEntryTypeId)` Unsubscribe the user from changes in documents of the file entry type.
`void`	`unsubscribeFolder(long groupId, long folderId)` Unsubscribe the user from document changes in the folder.
`FileEntry`	`updateFileEntry(long fileEntryId, String sourceFileName, String mimeType, String title, String description, String changeLog, boolean majorVersion, byte[] bytes, ServiceContext serviceContext)` Updates a file entry and associated metadata based on a byte array object.
`FileEntry`	`updateFileEntry(long fileEntryId, String sourceFileName, String mimeType, String title, String description, String changeLog, boolean majorVersion, File file, ServiceContext serviceContext)` Updates a file entry and associated metadata based on a `File` object.
`FileEntry`	`updateFileEntry(long fileEntryId, String sourceFileName, String mimeType, String title, String description, String changeLog, boolean majorVersion, InputStream is, long size, ServiceContext serviceContext)` Updates a file entry and associated metadata based on an `InputStream` object.
`FileEntry`	`updateFileEntryAndCheckIn(long fileEntryId, String sourceFileName, String mimeType, String title, String description, String changeLog, boolean majorVersion, File file, ServiceContext serviceContext)`
`FileEntry`	`updateFileEntryAndCheckIn(long fileEntryId, String sourceFileName, String mimeType, String title, String description, String changeLog, boolean majorVersion, InputStream is, long size, ServiceContext serviceContext)`
`FileShortcut`	`updateFileShortcut(long fileShortcutId, long folderId, long toFileEntryId, ServiceContext serviceContext)` Updates a file shortcut to the existing file entry.
`Folder`	`updateFolder(long folderId, String name, String description, ServiceContext serviceContext)` Updates the folder.
`boolean`	`verifyFileEntryCheckOut(long repositoryId, long fileEntryId, String lockUuid)` Returns `true` if the file entry is checked out.
`boolean`	`verifyFileEntryLock(long repositoryId, long fileEntryId, String lockUuid)`
`boolean`	`verifyInheritableLock(long repositoryId, long folderId, String lockUuid)` Returns `true` if the inheritable lock exists.

Method Detail

addFileEntry
```
FileEntry addFileEntry(long repositoryId,
                       long folderId,
                       String sourceFileName,
                       String mimeType,
                       String title,
                       String description,
                       String changeLog,
                       byte[] bytes,
                       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:

repositoryId - the primary key of the repository

folderId - the primary key of the file entry's parent folder

sourceFileName - the original file's name

mimeType - the file's MIME type

title - the name to be assigned to the file (optionally null)

description - the file's description

changeLog - the file's version change log

bytes - the file's data (optionally null)
serviceContext - the service context to be applied. Can set the asset category IDs, asset tag names, and expando bridge attributes for the file entry. In a Liferay repository, it may include:
- fileEntryTypeId - ID for a custom file entry type
- fieldsMap - mapping for fields associated with a custom file entry type
Returns:

the file entry

Throws:

PortalException

addFileEntry
```
FileEntry addFileEntry(long repositoryId,
                       long folderId,
                       String sourceFileName,
                       String mimeType,
                       String title,
                       String description,
                       String changeLog,
                       File file,
                       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:

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

addFileEntry
```
FileEntry addFileEntry(long repositoryId,
                       long folderId,
                       String sourceFileName,
                       String mimeType,
                       String title,
                       String description,
                       String changeLog,
                       InputStream is,
                       long size,
                       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:

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

is - the file's data (optionally null)

size - the file's size (optionally 0)
serviceContext - the service context to be applied. Can set the asset category IDs, asset tag names, and expando bridge attributes for the file entry. In a Liferay repository, it may include:
- fileEntryTypeId - ID for a custom file entry type
- fieldsMap - mapping for fields associated with a custom file entry type
Returns:

the file entry

Throws:

PortalException

addFileShortcut
```
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

addFolder
```
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

addTempFileEntry
```
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

See Also:

TempFileEntryUtil

addTempFileEntry
```
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

See Also:

TempFileEntryUtil

cancelCheckOut
```
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

See Also:

checkInFileEntry(long, boolean, String, ServiceContext), checkOutFileEntry(long, ServiceContext)

checkInFileEntry
```
void checkInFileEntry(long fileEntryId,
                      boolean majorVersion,
                      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

majorVersion - whether the new file version is a major version

changeLog - the file's version change log

serviceContext - the service context to be applied

Throws:

PortalException

See Also:

cancelCheckOut(long), checkOutFileEntry(long, ServiceContext)

checkInFileEntry
```
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

See Also:

cancelCheckOut(long), checkOutFileEntry(long, String, long, ServiceContext)

checkOutFileEntry
```
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

See Also:

cancelCheckOut(long), checkInFileEntry(long, boolean, String, ServiceContext)

checkOutFileEntry
```
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

See Also:

cancelCheckOut(long), #checkInFileEntry(long, String)

copyFolder
```
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

deleteFileEntry
```
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

deleteFileEntryByTitle
```
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

deleteFileShortcut
```
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

deleteFileVersion
```
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

deleteFolder
```
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

deleteFolder
```
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

deleteTempFileEntry
```
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

See Also:

TempFileEntryUtil

getFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

getFileEntries
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

getFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<FileEntry> getFileEntries(long repositoryId,
                                                                                                  long folderId,
                                                                                                  int start,
                                                                                                  int end,
                                                                                                  OrderByComparator<FileEntry> obc)
                                                                                           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); obc - the comparator to order the file entries (optionally null)
Returns:: the range of file entries in the folder ordered by comparator obc
Throws:: PortalException

getFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

getFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

getFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<FileEntry> getFileEntries(long repositoryId,
                                                                                                  long folderId,
                                                                                                  long fileEntryTypeId,
                                                                                                  int start,
                                                                                                  int end,
                                                                                                  OrderByComparator<FileEntry> obc)
                                                                                           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); obc - the comparator to order the results by (optionally null)
Returns:: the range of file entries with the file entry type in the folder ordered by null
Throws:: PortalException

getFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<FileEntry> getFileEntries(long repositoryId,
                                                                                                  long folderId,
                                                                                                  String[] mimeTypes)
                                                                                           throws PortalException

Throws:: PortalException

getFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<FileEntry> getFileEntries(long repositoryId,
                                                                                                  long folderId,
                                                                                                  String[] mimeTypes,
                                                                                                  int start,
                                                                                                  int end,
                                                                                                  OrderByComparator<FileEntry> obc)
                                                                                           throws PortalException

Throws:: PortalException

getFileEntriesAndFileShortcuts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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.

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

getFileEntriesAndFileShortcutsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

getFileEntriesAndFileShortcutsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

getFileEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

getFileEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

getFileEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFileEntriesCount(long repositoryId,
                                                                                           long folderId,
                                                                                           String[] mimeTypes)
                                                                                    throws PortalException

Throws:: PortalException

getFileEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

getFileEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

getFileEntryByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

getFileShortcut
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

getFileVersion

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

getFolder

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

getFolder

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

getFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

getFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

getFolders
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

getFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Folder> getFolders(long repositoryId,
                                                                                           long parentFolderId,
                                                                                           boolean includeMountFolders,
                                                                                           int start,
                                                                                           int end,
                                                                                           OrderByComparator<Folder> obc)
                                                                                    throws PortalException

Returns an ordered range of all the 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; includeMountFolders - whether to include mount folders for third-party repositories; start - the lower bound of the range of results; end - the upper bound of the range of results (not inclusive); obc - the comparator to order the folders (optionally null)
Returns:: the range of immediate subfolders of the parent folder ordered by comparator obc
Throws:: PortalException

getFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Folder> getFolders(long repositoryId,
                                                                                           long parentFolderId,
                                                                                           int status,
                                                                                           boolean includeMountFolders,
                                                                                           int start,
                                                                                           int end,
                                                                                           OrderByComparator<Folder> obc)
                                                                                    throws PortalException

Returns an ordered range of all the 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; status - the workflow status; includeMountFolders - whether to include mount folders for third-party repositories; start - the lower bound of the range of results; end - the upper bound of the range of results (not inclusive); obc - the comparator to order the folders (optionally null)
Returns:: the range of immediate subfolders of the parent folder ordered by comparator obc
Throws:: PortalException

getFolders
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

getFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Folder> getFolders(long repositoryId,
                                                                                           long parentFolderId,
                                                                                           int start,
                                                                                           int end,
                                                                                           OrderByComparator<Folder> obc)
                                                                                    throws PortalException

Returns an ordered range of all the 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; start - the lower bound of the range of results; end - the upper bound of the range of results (not inclusive); obc - the comparator to order the folders (optionally null)
Returns:: the range of immediate subfolders of the parent folder ordered by comparator obc
Throws:: PortalException

getFoldersAndFileEntriesAndFileShortcuts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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.

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

getFoldersAndFileEntriesAndFileShortcuts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Object> getFoldersAndFileEntriesAndFileShortcuts(long repositoryId,
                                                                                                                         long folderId,
                                                                                                                         int status,
                                                                                                                         boolean includeMountFolders,
                                                                                                                         int start,
                                                                                                                         int end,
                                                                                                                         OrderByComparator<?> obc)
                                                                                                                  throws PortalException

Returns an ordered range of all the 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; start - the lower bound of the range of results; end - the upper bound of the range of results (not inclusive); obc - the comparator to order the results (optionally null)
Returns:: the range of immediate subfolders, file entries, and file shortcuts in the parent folder ordered by comparator obc
Throws:: PortalException

getFoldersAndFileEntriesAndFileShortcuts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Object> getFoldersAndFileEntriesAndFileShortcuts(long repositoryId,
                                                                                                                         long folderId,
                                                                                                                         int status,
                                                                                                                         String[] mimeTypes,
                                                                                                                         boolean includeMountFolders,
                                                                                                                         boolean includeOwner,
                                                                                                                         int start,
                                                                                                                         int end,
                                                                                                                         OrderByComparator<?> obc)
                                                                                                                  throws PortalException

Throws:: PortalException

getFoldersAndFileEntriesAndFileShortcuts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Object> getFoldersAndFileEntriesAndFileShortcuts(long repositoryId,
                                                                                                                         long folderId,
                                                                                                                         int status,
                                                                                                                         String[] mimeTypes,
                                                                                                                         boolean includeMountFolders,
                                                                                                                         int start,
                                                                                                                         int end,
                                                                                                                         OrderByComparator<?> obc)
                                                                                                                  throws PortalException

Throws:: PortalException

getFoldersAndFileEntriesAndFileShortcutsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

getFoldersAndFileEntriesAndFileShortcutsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFoldersAndFileEntriesAndFileShortcutsCount(long repositoryId,
                                                                                                                     long folderId,
                                                                                                                     int status,
                                                                                                                     String[] mimeTypes,
                                                                                                                     boolean includeMountFolders)
                                                                                                              throws PortalException

Throws:: PortalException

getFoldersAndFileEntriesAndFileShortcutsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFoldersAndFileEntriesAndFileShortcutsCount(long repositoryId,
                                                                                                                     long folderId,
                                                                                                                     int status,
                                                                                                                     String[] mimeTypes,
                                                                                                                     boolean includeMountFolders,
                                                                                                                     boolean includeOwner)
                                                                                                              throws PortalException

Throws:: PortalException

getFoldersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

getFoldersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

getFoldersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

getFoldersFileEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

getGroupFileEntries
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

getGroupFileEntries
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<FileEntry> getGroupFileEntries(long groupId,
                                                                                                       long userId,
                                                                                                       int start,
                                                                                                       int end,
                                                                                                       OrderByComparator<FileEntry> obc)
                                                                                                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)

obc - the comparator to order the file entries (optionally null)

Returns:

the range of matching file entries ordered by comparator obc

Throws:

PortalException

getGroupFileEntries
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

getGroupFileEntries
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<FileEntry> getGroupFileEntries(long groupId,
                                                                                                       long userId,
                                                                                                       long rootFolderId,
                                                                                                       int start,
                                                                                                       int end,
                                                                                                       OrderByComparator<FileEntry> obc)
                                                                                                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)

obc - the comparator to order the file entries (optionally null)

Returns:

the range of matching file entries ordered by comparator obc

Throws:

PortalException

getGroupFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<FileEntry> getGroupFileEntries(long groupId,
                                                                                                       long userId,
                                                                                                       long rootFolderId,
                                                                                                       String[] mimeTypes,
                                                                                                       int status,
                                                                                                       int start,
                                                                                                       int end,
                                                                                                       OrderByComparator<FileEntry> obc)
                                                                                                throws PortalException

Throws:: PortalException

getGroupFileEntriesCount
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

getGroupFileEntriesCount
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

getGroupFileEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getGroupFileEntriesCount(long groupId,
                                                                                                long userId,
                                                                                                long rootFolderId,
                                                                                                String[] mimeTypes,
                                                                                                int status)
                                                                                         throws PortalException

Throws:: PortalException

getMountFolders
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

getMountFolders
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

getMountFolders
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Folder> getMountFolders(long repositoryId,
                                                                                                long parentFolderId,
                                                                                                int start,
                                                                                                int end,
                                                                                                OrderByComparator<Folder> obc)
                                                                                         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)

obc - the comparator to order the folders (optionally null)

Returns:

the range of immediate subfolders of the parent folder that are used for mounting third-party repositories ordered by comparator obc

Throws:

PortalException

getMountFoldersCount
```
@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

getOSGiServiceIdentifier
```
String getOSGiServiceIdentifier()
```
Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getSubfolderIds

@Transactional(propagation=SUPPORTS,
               readOnly=true)
void getSubfolderIds(long repositoryId,
                                                                                        List<Long> folderIds,
                                                                                        long folderId)
                                                                                 throws PortalException

Throws:: PortalException

getSubfolderIds

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

getSubfolderIds

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

getTempFileNames

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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
See Also:: addTempFileEntry(long, long, String, String, File, String), TempFileEntryUtil

lockFolder
```
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

lockFolder
```
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

moveFileEntry
```
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

moveFolder
```
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

refreshFileEntryLock
```
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

refreshFolderLock
```
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

revertFileEntry
```
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

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Hits search(long repositoryId,
                                                                               long creatorUserId,
                                                                               int status,
                                                                               int start,
                                                                               int end)
                                                                        throws PortalException

Throws:: PortalException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Hits search(long repositoryId,
                                                                               long creatorUserId,
                                                                               long folderId,
                                                                               String[] mimeTypes,
                                                                               int status,
                                                                               int start,
                                                                               int end)
                                                                        throws PortalException

Throws:: PortalException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Hits search(long repositoryId,
                                                                               SearchContext searchContext)
                                                                        throws SearchException

Throws:: SearchException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Hits search(long repositoryId,
                                                                               SearchContext searchContext,
                                                                               Query query)
                                                                        throws SearchException

Throws:: SearchException

subscribeFileEntryType
```
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

subscribeFolder
```
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

unlockFolder
```
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

unlockFolder
```
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

unsubscribeFileEntryType
```
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

unsubscribeFolder
```
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

updateFileEntry
```
FileEntry updateFileEntry(long fileEntryId,
                          String sourceFileName,
                          String mimeType,
                          String title,
                          String description,
                          String changeLog,
                          boolean majorVersion,
                          byte[] bytes,
                          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)

majorVersion - whether the new file version is a major version

bytes - the file's data (optionally null)
serviceContext - the service context to be applied. Can set the asset category IDs, asset tag names, and expando bridge attributes for the file entry. In a Liferay repository, it may include:
- fileEntryTypeId - ID for a custom file entry type
- fieldsMap - mapping for fields associated with a custom file entry type
Returns:

the file entry

Throws:

PortalException

updateFileEntry
```
FileEntry updateFileEntry(long fileEntryId,
                          String sourceFileName,
                          String mimeType,
                          String title,
                          String description,
                          String changeLog,
                          boolean majorVersion,
                          File file,
                          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)

majorVersion - whether the new file version is a major version

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

updateFileEntry
```
FileEntry updateFileEntry(long fileEntryId,
                          String sourceFileName,
                          String mimeType,
                          String title,
                          String description,
                          String changeLog,
                          boolean majorVersion,
                          InputStream is,
                          long size,
                          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)

majorVersion - whether the new file version is a major version

is - the file's data (optionally null)

size - the file's size (optionally 0)
serviceContext - the service context to be applied. Can set the asset category IDs, asset tag names, and expando bridge attributes for the file entry. In a Liferay repository, it may include:
- fileEntryTypeId - ID for a custom file entry type
- fieldsMap - mapping for fields associated with a custom file entry type
Returns:

the file entry

Throws:

PortalException

updateFileEntryAndCheckIn

FileEntry updateFileEntryAndCheckIn(long fileEntryId,
                                    String sourceFileName,
                                    String mimeType,
                                    String title,
                                    String description,
                                    String changeLog,
                                    boolean majorVersion,
                                    File file,
                                    ServiceContext serviceContext)
                             throws PortalException

Throws:: PortalException

updateFileEntryAndCheckIn

FileEntry updateFileEntryAndCheckIn(long fileEntryId,
                                    String sourceFileName,
                                    String mimeType,
                                    String title,
                                    String description,
                                    String changeLog,
                                    boolean majorVersion,
                                    InputStream is,
                                    long size,
                                    ServiceContext serviceContext)
                             throws PortalException

Throws:: PortalException

updateFileShortcut
```
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

updateFolder
```
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

verifyFileEntryCheckOut
```
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

verifyFileEntryLock

boolean verifyFileEntryLock(long repositoryId,
                            long fileEntryId,
                            String lockUuid)
                     throws PortalException

Throws:: PortalException

verifyInheritableLock
```
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

Interface DLAppService

Method Summary

Method Detail

addFileEntry

addFileEntry

addFileEntry

addFileShortcut

addFolder

addTempFileEntry

addTempFileEntry

cancelCheckOut

checkInFileEntry

checkInFileEntry

checkOutFileEntry

checkOutFileEntry

copyFolder

deleteFileEntry

deleteFileEntryByTitle

deleteFileShortcut

deleteFileVersion

deleteFolder

deleteFolder

deleteTempFileEntry

getFileEntries

getFileEntries

getFileEntries

getFileEntries

getFileEntries

getFileEntries

getFileEntries

getFileEntries

getFileEntriesAndFileShortcuts

getFileEntriesAndFileShortcutsCount

getFileEntriesAndFileShortcutsCount

getFileEntriesCount

getFileEntriesCount

getFileEntriesCount

getFileEntry

getFileEntry

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

getMountFolders

getMountFoldersCount

getOSGiServiceIdentifier

getSubfolderIds

getSubfolderIds

getSubfolderIds

getTempFileNames

lockFolder