Liferay 6.2-ce-ga5

com.liferay.portlet.documentlibrary.service
Class DLAppServiceWrapper

java.lang.Object
  extended by com.liferay.portlet.documentlibrary.service.DLAppServiceWrapper
All Implemented Interfaces:
BaseService, ServiceWrapper<DLAppService>, DLAppService

@ProviderType
public class DLAppServiceWrapper
extends Object
implements DLAppService, ServiceWrapper<DLAppService>

Provides a wrapper for DLAppService.

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

Constructor Summary
DLAppServiceWrapper(DLAppService dlAppService)
           
 
Method Summary
 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.
 DLFileShortcut 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 fileName, String tempFolderName, File file, String mimeType)
          Adds a temporary file entry.
 FileEntry addTempFileEntry(long groupId, long folderId, String fileName, String tempFolderName, 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)
          Deprecated. As of 6.2.0, replaced by checkInFileEntry(long, String, ServiceContext)
 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 fileName, String tempFolderName)
          Deletes the temporary file entry.
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 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 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 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<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.
 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.
 DLFileShortcut getFileShortcut(long fileShortcutId)
          Returns the file shortcut 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 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 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 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, 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 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 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 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 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 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.
 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[] getTempFileEntryNames(long groupId, long folderId, String tempFolderName)
          Returns all the temporary file entry names.
 DLAppService getWrappedDLAppService()
          Deprecated. As of 6.1.0, replaced by getWrappedService()
 DLAppService getWrappedService()
           
 Lock lockFileEntry(long fileEntryId)
          Deprecated. As of 6.2.0, replaced by checkOutFileEntry(long, ServiceContext)
 Lock lockFileEntry(long fileEntryId, String owner, long expirationTime)
          Deprecated. As of 6.2.0, replaced by checkOutFileEntry(long, String, long, ServiceContext)
 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.
 FileEntry moveFileEntryFromTrash(long fileEntryId, long newFolderId, ServiceContext serviceContext)
          Moves the file entry from a trashed folder to the new folder.
 FileEntry moveFileEntryToTrash(long fileEntryId)
          Moves the file entry with the primary key to the trash portlet.
 DLFileShortcut moveFileShortcutFromTrash(long fileShortcutId, long newFolderId, ServiceContext serviceContext)
          Moves the file shortcut from a trashed folder to the new folder.
 DLFileShortcut moveFileShortcutToTrash(long fileShortcutId)
          Moves the file shortcut with the primary key to the trash portlet.
 Folder moveFolder(long folderId, long parentFolderId, ServiceContext serviceContext)
          Moves the folder to the new parent folder with the primary key.
 Folder moveFolderFromTrash(long folderId, long parentFolderId, ServiceContext serviceContext)
          Moves the folder with the primary key from the trash portlet to the new parent folder with the primary key.
 Folder moveFolderToTrash(long folderId)
          Moves the folder with the primary key to the trash portlet.
 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 restoreFileEntryFromTrash(long fileEntryId)
          Restores the file entry with the primary key from the trash portlet.
 void restoreFileShortcutFromTrash(long fileShortcutId)
          Restores the file shortcut with the primary key from the trash portlet.
 void restoreFolderFromTrash(long folderId)
          Restores the folder with the primary key from the trash portlet.
 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 setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void setWrappedDLAppService(DLAppService dlAppService)
          Deprecated. As of 6.1.0, replaced by setWrappedService(com.liferay.portlet.documentlibrary.service.DLAppService)
 void setWrappedService(DLAppService dlAppService)
           
 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 unlockFileEntry(long fileEntryId)
          Deprecated. As of 6.2.0, replaced by checkInFileEntry(long, boolean, String, ServiceContext).
 void unlockFileEntry(long fileEntryId, String lockUuid)
          Deprecated. As of 6.2.0, replaced by checkInFileEntry(long, String).
 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)
           
 DLFileShortcut 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DLAppServiceWrapper

public DLAppServiceWrapper(DLAppService dlAppService)
Method Detail

getBeanIdentifier

public String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Specified by:
getBeanIdentifier in interface DLAppService
Returns:
the Spring bean ID for this bean

setBeanIdentifier

public void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Specified by:
setBeanIdentifier in interface DLAppService
Parameters:
beanIdentifier - the Spring bean ID for this bean

addFileEntry

public FileEntry addFileEntry(long repositoryId,
                              long folderId,
                              String sourceFileName,
                              String mimeType,
                              String title,
                              String description,
                              String changeLog,
                              byte[] bytes,
                              ServiceContext serviceContext)
                       throws PortalException,
                              SystemException
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.

Specified by:
addFileEntry in interface DLAppService
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 - if the parent folder could not be found or if the file entry's information was invalid
SystemException - if a system exception occurred

addFileEntry

public FileEntry addFileEntry(long repositoryId,
                              long folderId,
                              String sourceFileName,
                              String mimeType,
                              String title,
                              String description,
                              String changeLog,
                              File file,
                              ServiceContext serviceContext)
                       throws PortalException,
                              SystemException
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.

Specified by:
addFileEntry in interface DLAppService
Parameters:
repositoryId - the primary key of the repository
folderId - the primary key of the file entry's parent folder
sourceFileName - the original file's name
mimeType - the file's MIME type
title - the name to be assigned to the file (optionally null )
description - the file's description
changeLog - the file's version change log
file - the file's data (optionally null)
serviceContext - the service context to be applied. Can set the asset category IDs, asset tag names, and expando bridge attributes for the file entry. In a Liferay repository, it may include:
  • fileEntryTypeId - ID for a custom file entry type
  • fieldsMap - mapping for fields associated with a custom file entry type
Returns:
the file entry
Throws:
PortalException - if the parent folder could not be found or if the file entry's information was invalid
SystemException - if a system exception occurred

addFileEntry

public FileEntry addFileEntry(long repositoryId,
                              long folderId,
                              String sourceFileName,
                              String mimeType,
                              String title,
                              String description,
                              String changeLog,
                              InputStream is,
                              long size,
                              ServiceContext serviceContext)
                       throws PortalException,
                              SystemException
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.

Specified by:
addFileEntry in interface DLAppService
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 - if the parent folder could not be found or if the file entry's information was invalid
SystemException - if a system exception occurred

addFileShortcut

public DLFileShortcut addFileShortcut(long repositoryId,
                                      long folderId,
                                      long toFileEntryId,
                                      ServiceContext serviceContext)
                               throws PortalException,
                                      SystemException
Adds a file shortcut to the existing file entry. This method is only supported by the Liferay repository.

Specified by:
addFileShortcut in interface DLAppService
Parameters:
repositoryId - the primary key of the repository
folderId - the primary key of the file shortcut's parent folder
toFileEntryId - the primary key of the file shortcut's file entry
serviceContext - the service context to be applied. Can set the asset category IDs, asset tag names, and expando bridge attributes for the file entry.
Returns:
the file shortcut
Throws:
PortalException - if the parent folder or file entry could not be found, or if the file shortcut's information was invalid
SystemException - if a system exception occurred

addFolder

public Folder addFolder(long repositoryId,
                        long parentFolderId,
                        String name,
                        String description,
                        ServiceContext serviceContext)
                 throws PortalException,
                        SystemException
Adds a folder.

Specified by:
addFolder in interface DLAppService
Parameters:
repositoryId - the primary key of the repository
parentFolderId - the primary key of the folder's parent folder
name - the folder's name
description - the folder's description
serviceContext - the service context to be applied. In a Liferay repository, it may include boolean mountPoint specifying whether folder is a facade for mounting a third-party repository
Returns:
the folder
Throws:
PortalException - if the parent folder could not be found or if the new folder's information was invalid
SystemException - if a system exception occurred

addTempFileEntry

public FileEntry addTempFileEntry(long groupId,
                                  long folderId,
                                  String fileName,
                                  String tempFolderName,
                                  File file,
                                  String mimeType)
                           throws PortalException,
                                  SystemException
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.

Specified by:
addTempFileEntry in interface DLAppService
Parameters:
groupId - the primary key of the group
folderId - the primary key of the folder where the file entry will eventually reside
fileName - the file's original name
tempFolderName - the temporary folder's name
file - the file's data (optionally null)
mimeType - the file's MIME type
Returns:
the temporary file entry
Throws:
PortalException - if the file name was invalid
SystemException - if a system exception occurred
See Also:
TempFileUtil

addTempFileEntry

public FileEntry addTempFileEntry(long groupId,
                                  long folderId,
                                  String fileName,
                                  String tempFolderName,
                                  InputStream inputStream,
                                  String mimeType)
                           throws PortalException,
                                  SystemException
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.

Specified by:
addTempFileEntry in interface DLAppService
Parameters:
groupId - the primary key of the group
folderId - the primary key of the folder where the file entry will eventually reside
fileName - the file's original name
tempFolderName - the temporary folder's name
inputStream - the file's data
mimeType - the file's MIME type
Returns:
the temporary file entry
Throws:
PortalException - if the file name was invalid or if a portal exception occurred
SystemException - if a system exception occurred
See Also:
TempFileUtil

cancelCheckOut

public void cancelCheckOut(long fileEntryId)
                    throws PortalException,
                           SystemException
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.

Specified by:
cancelCheckOut in interface DLAppService
Parameters:
fileEntryId - the primary key of the file entry to cancel the checkout
Throws:
PortalException - if the file entry could not be found
SystemException - if a system exception occurred
See Also:
checkInFileEntry(long, boolean, String, ServiceContext), checkOutFileEntry(long, ServiceContext)

checkInFileEntry

public void checkInFileEntry(long fileEntryId,
                             boolean majorVersion,
                             String changeLog,
                             ServiceContext serviceContext)
                      throws PortalException,
                             SystemException
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.

Specified by:
checkInFileEntry in interface DLAppService
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 - if the file entry could not be found
SystemException - if a system exception occurred
See Also:
cancelCheckOut(long), checkOutFileEntry(long, ServiceContext)

checkInFileEntry

public void checkInFileEntry(long fileEntryId,
                             String lockUuid)
                      throws PortalException,
                             SystemException
Deprecated. As of 6.2.0, replaced by checkInFileEntry(long, String, ServiceContext)

Specified by:
checkInFileEntry in interface DLAppService
Throws:
PortalException
SystemException

checkInFileEntry

public void checkInFileEntry(long fileEntryId,
                             String lockUuid,
                             ServiceContext serviceContext)
                      throws PortalException,
                             SystemException
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.

Specified by:
checkInFileEntry in interface DLAppService
Parameters:
fileEntryId - the primary key of the file entry to check in
lockUuid - the lock's UUID
serviceContext - the service context to be applied
Throws:
PortalException - if the file entry could not be found
SystemException - if a system exception occurred
See Also:
cancelCheckOut(long), checkOutFileEntry(long, String, long, ServiceContext)

checkOutFileEntry

public void checkOutFileEntry(long fileEntryId,
                              ServiceContext serviceContext)
                       throws PortalException,
                              SystemException
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.

Specified by:
checkOutFileEntry in interface DLAppService
Parameters:
fileEntryId - the file entry to check out
serviceContext - the service context to be applied
Throws:
PortalException - if the file entry could not be found
SystemException - if a system exception occurred
See Also:
cancelCheckOut(long), checkInFileEntry(long, boolean, String, ServiceContext)

checkOutFileEntry

public FileEntry checkOutFileEntry(long fileEntryId,
                                   String owner,
                                   long expirationTime,
                                   ServiceContext serviceContext)
                            throws PortalException,
                                   SystemException
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.

Specified by:
checkOutFileEntry in interface DLAppService
Parameters:
fileEntryId - the file entry to check out
owner - the owner string for the checkout (optionally null)
expirationTime - the time in milliseconds before the lock expires. If the value is 0, the default expiration time will be used from portal.properties>.
serviceContext - the service context to be applied
Returns:
the file entry
Throws:
PortalException - if the file entry could not be found
SystemException - if a system exception occurred
See Also:
cancelCheckOut(long), checkInFileEntry(long, String)

copyFolder

public Folder copyFolder(long repositoryId,
                         long sourceFolderId,
                         long parentFolderId,
                         String name,
                         String description,
                         ServiceContext serviceContext)
                  throws PortalException,
                         SystemException
Performs a deep copy of the folder.

Specified by:
copyFolder in interface DLAppService
Parameters:
repositoryId - the primary key of the repository
sourceFolderId - the primary key of the folder to copy
parentFolderId - the primary key of the new folder's parent folder
name - the new folder's name
description - the new folder's description
serviceContext - the service context to be applied
Returns:
the folder
Throws:
PortalException - if the source folder or the new parent folder could not be found or if the new folder's information was invalid
SystemException - if a system exception occurred

deleteFileEntry

public void deleteFileEntry(long fileEntryId)
                     throws PortalException,
                            SystemException
Deletes the file entry with the primary key.

Specified by:
deleteFileEntry in interface DLAppService
Parameters:
fileEntryId - the primary key of the file entry
Throws:
PortalException - if the file entry could not be found
SystemException - if a system exception occurred

deleteFileEntryByTitle

public void deleteFileEntryByTitle(long repositoryId,
                                   long folderId,
                                   String title)
                            throws PortalException,
                                   SystemException
Deletes the file entry with the title in the folder.

Specified by:
deleteFileEntryByTitle in interface DLAppService
Parameters:
repositoryId - the primary key of the repository
folderId - the primary key of the file entry's parent folder
title - the file entry's title
Throws:
PortalException - if the file entry could not be found
SystemException - if a system exception occurred

deleteFileShortcut

public void deleteFileShortcut(long fileShortcutId)
                        throws PortalException,
                               SystemException
Deletes the file shortcut with the primary key. This method is only supported by the Liferay repository.

Specified by:
deleteFileShortcut in interface DLAppService
Parameters:
fileShortcutId - the primary key of the file shortcut
Throws:
PortalException - if the file shortcut could not be found
SystemException - if a system exception occurred

deleteFileVersion

public void deleteFileVersion(long fileEntryId,
                              String version)
                       throws PortalException,
                              SystemException
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.

Specified by:
deleteFileVersion in interface DLAppService
Parameters:
fileEntryId - the primary key of the file entry
version - the version label of the file version
Throws:
PortalException - if the file version could not be found or invalid
SystemException - if a system exception occurred

deleteFolder

public void deleteFolder(long folderId)
                  throws PortalException,
                         SystemException
Deletes the folder with the primary key and all of its subfolders and file entries.

Specified by:
deleteFolder in interface DLAppService
Parameters:
folderId - the primary key of the folder
Throws:
PortalException - if the folder could not be found
SystemException - if a system exception occurred

deleteFolder

public void deleteFolder(long repositoryId,
                         long parentFolderId,
                         String name)
                  throws PortalException,
                         SystemException
Deletes the folder with the name in the parent folder and all of its subfolders and file entries.

Specified by:
deleteFolder in interface DLAppService
Parameters:
repositoryId - the primary key of the repository
parentFolderId - the primary key of the folder's parent folder
name - the folder's name
Throws:
PortalException - if the folder could not be found
SystemException - if a system exception occurred

deleteTempFileEntry

public void deleteTempFileEntry(long groupId,
                                long folderId,
                                String fileName,
                                String tempFolderName)
                         throws PortalException,
                                SystemException
Deletes the temporary file entry.

Specified by:
deleteTempFileEntry in interface DLAppService
Parameters:
groupId - the primary key of the group
folderId - the primary key of the folder where the file entry was eventually to reside
fileName - the file's original name
tempFolderName - the temporary folder's name
Throws:
PortalException - if the file name was invalid
SystemException - if a system exception occurred
See Also:
TempFileUtil

getFileEntries

public List<FileEntry> getFileEntries(long repositoryId,
                                      long folderId)
                               throws PortalException,
                                      SystemException
Returns all the file entries in the folder.

Specified by:
getFileEntries in interface DLAppService
Parameters:
repositoryId - the primary key of the file entry's repository
folderId - the primary key of the file entry's folder
Returns:
the file entries in the folder
Throws:
PortalException - if the folder could not be found
SystemException - if a system exception occurred

getFileEntries

public List<FileEntry> getFileEntries(long repositoryId,
                                      long folderId,
                                      int start,
                                      int end)
                               throws PortalException,
                                      SystemException
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.

Specified by:
getFileEntries in interface DLAppService
Parameters:
repositoryId - the primary key of the file entry's repository
folderId - the primary key of the file entry's folder
start - the lower bound of the range of results
end - the upper bound of the range of results (not inclusive)
Returns:
the name-ordered range of file entries in the folder
Throws:
PortalException - if the folder could not be found
SystemException - if a system exception occurred

getFileEntries

public List<FileEntry> getFileEntries(long repositoryId,
                                      long folderId,
                                      int start,
                                      int end,
                                      OrderByComparator obc)
                               throws PortalException,
                                      SystemException
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.

Specified by:
getFileEntries in interface DLAppService
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 - if the folder could not be found
SystemException - if a system exception occurred

getFileEntries

public List<FileEntry> getFileEntries(long repositoryId,
                                      long folderId,
                                      long fileEntryTypeId)
                               throws PortalException,
                                      SystemException
Returns the file entries with the file entry type in the folder.

Specified by:
getFileEntries in interface DLAppService
Parameters:
repositoryId - the primary key of the file entry's repository
folderId - the primary key of the file entry's folder
fileEntryTypeId - the primary key of the file entry type
Returns:
the file entries with the file entry type in the folder
Throws:
PortalException - if the folder could not be found
SystemException - if a system exception occurred

getFileEntries

public List<FileEntry> getFileEntries(long repositoryId,
                                      long folderId,
                                      long fileEntryTypeId,
                                      int start,
                                      int end)
                               throws PortalException,
                                      SystemException
Returns a name-ordered range of all the file entries with the file entry type in the folder.

Specified by:
getFileEntries in interface DLAppService
Parameters:
repositoryId - the primary key of the file entry's repository
folderId - the primary key of the file entry's folder
fileEntryTypeId - the primary key of the file entry type
start - the lower bound of the range of results
end - the upper bound of the range of results (not inclusive)
Returns:
the name-ordered range of the file entries in the folder
Throws:
PortalException - if the folder could not be found
SystemException - if a system exception occurred

getFileEntries

public List<FileEntry> getFileEntries(long repositoryId,
                                      long folderId,
                                      long fileEntryTypeId,
                                      int start,
                                      int end,
                                      OrderByComparator obc)
                               throws PortalException,
                                      SystemException
Returns an ordered range of all the file entries with the file entry type in the folder.

Specified by:
getFileEntries in interface DLAppService
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 - if the folder could not be found
SystemException - if a system exception occurred

getFileEntries

public List<FileEntry> getFileEntries(long repositoryId,
                                      long folderId,
                                      String[] mimeTypes)
                               throws PortalException,
                                      SystemException
Specified by:
getFileEntries in interface DLAppService
Throws:
PortalException
SystemException

getFileEntriesAndFileShortcuts

public List<Object> getFileEntriesAndFileShortcuts(long repositoryId,
                                                   long folderId,
                                                   int status,
                                                   int start,
                                                   int end)
                                            throws PortalException,
                                                   SystemException
Returns a range of all the file entries and shortcuts in the folder.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Specified by:
getFileEntriesAndFileShortcuts in interface DLAppService
Parameters:
repositoryId - the primary key of the repository
folderId - the primary key of the folder
status - the workflow status
start - the lower bound of the range of results
end - the upper bound of the range of results (not inclusive)
Returns:
the range of file entries and shortcuts in the folder
Throws:
PortalException - if the folder could not be found
SystemException - if a system exception occurred

getFileEntriesAndFileShortcutsCount

public int getFileEntriesAndFileShortcutsCount(long repositoryId,
                                               long folderId,
                                               int status)
                                        throws PortalException,
                                               SystemException
Returns the number of file entries and shortcuts in the folder.

Specified by:
getFileEntriesAndFileShortcutsCount in interface DLAppService
Parameters:
repositoryId - the primary key of the repository
folderId - the primary key of the folder
status - the workflow status
Returns:
the number of file entries and shortcuts in the folder
Throws:
PortalException - if the folder ould not be found
SystemException - if a system exception occurred

getFileEntriesAndFileShortcutsCount

public int getFileEntriesAndFileShortcutsCount(long repositoryId,
                                               long folderId,
                                               int status,
                                               String[] mimeTypes)
                                        throws PortalException,
                                               SystemException
Returns the number of file entries and shortcuts in the folder.

Specified by:
getFileEntriesAndFileShortcutsCount in interface DLAppService
Parameters:
repositoryId - the primary key of the repository
folderId - the primary key of the folder
status - the workflow status
mimeTypes - allowed media types
Returns:
the number of file entries and shortcuts in the folder
Throws:
PortalException - if the folder ould not be found
SystemException - if a system exception occurred

getFileEntriesCount

public int getFileEntriesCount(long repositoryId,
                               long folderId)
                        throws PortalException,
                               SystemException
Returns the number of file entries in the folder.

Specified by:
getFileEntriesCount in interface DLAppService
Parameters:
repositoryId - the primary key of the file entry's repository
folderId - the primary key of the file entry's folder
Returns:
the number of file entries in the folder
Throws:
PortalException - if the folder could not be found
SystemException - if a system exception occurred

getFileEntriesCount

public int getFileEntriesCount(long repositoryId,
                               long folderId,
                               long fileEntryTypeId)
                        throws PortalException,
                               SystemException
Returns the number of file entries with the file entry type in the folder.

Specified by:
getFileEntriesCount in interface DLAppService
Parameters:
repositoryId - the primary key of the file entry's repository
folderId - the primary key of the file entry's folder
fileEntryTypeId - the primary key of the file entry type
Returns:
the number of file entries with the file entry type in the folder
Throws:
PortalException - if the folder could not be found
SystemException - if a system exception occurred

getFileEntry

public FileEntry getFileEntry(long fileEntryId)
                       throws PortalException,
                              SystemException
Returns the file entry with the primary key.

Specified by:
getFileEntry in interface DLAppService
Parameters:
fileEntryId - the primary key of the file entry
Returns:
the file entry with the primary key
Throws:
PortalException - if the file entry could not be found
SystemException - if a system exception occurred

getFileEntry

public FileEntry getFileEntry(long groupId,
                              long folderId,
                              String title)
                       throws PortalException,
                              SystemException
Returns the file entry with the title in the folder.

Specified by:
getFileEntry in interface DLAppService
Parameters:
groupId - the primary key of the file entry's group
folderId - the primary key of the file entry's folder
title - the file entry's title
Returns:
the file entry with the title in the folder
Throws:
PortalException - if the file entry could not be found
SystemException - if a system exception occurred

getFileEntryByUuidAndGroupId

public FileEntry getFileEntryByUuidAndGroupId(String uuid,
                                              long groupId)
                                       throws PortalException,
                                              SystemException
Returns the file entry with the UUID and group.

Specified by:
getFileEntryByUuidAndGroupId in interface DLAppService
Parameters:
uuid - the file entry's UUID
groupId - the primary key of the file entry's group
Returns:
the file entry with the UUID and group
Throws:
PortalException - if the file entry could not be found
SystemException - if a system exception occurred

getFileShortcut

public DLFileShortcut getFileShortcut(long fileShortcutId)
                               throws PortalException,
                                      SystemException
Returns the file shortcut with the primary key. This method is only supported by the Liferay repository.

Specified by:
getFileShortcut in interface DLAppService
Parameters:
fileShortcutId - the primary key of the file shortcut
Returns:
the file shortcut with the primary key
Throws:
PortalException - if the file shortcut could not be found
SystemException - if a system exception occurred

getFolder

public Folder getFolder(long folderId)
                 throws PortalException,
                        SystemException
Returns the folder with the primary key.

Specified by:
getFolder in interface DLAppService
Parameters:
folderId - the primary key of the folder
Returns:
the folder with the primary key
Throws:
PortalException - if the folder could not be found
SystemException - if a system exception occurred

getFolder

public Folder getFolder(long repositoryId,
                        long parentFolderId,
                        String name)
                 throws PortalException,
                        SystemException
Returns the folder with the name in the parent folder.

Specified by:
getFolder in interface DLAppService
Parameters:
repositoryId - the primary key of the folder's repository
parentFolderId - the primary key of the folder's parent folder
name - the folder's name
Returns:
the folder with the name in the parent folder
Throws:
PortalException - if the folder could not be found
SystemException - if a system exception occurred

getFolders

public List<Folder> getFolders(long repositoryId,
                               long parentFolderId)
                        throws PortalException,
                               SystemException
Returns all immediate subfolders of the parent folder.

Specified by:
getFolders in interface DLAppService
Parameters:
repositoryId - the primary key of the folder's repository
parentFolderId - the primary key of the folder's parent folder
Returns:
the immediate subfolders of the parent folder
Throws:
PortalException - if the parent folder could not be found
SystemException - if a system exception occurred

getFolders

public List<Folder> getFolders(long repositoryId,
                               long parentFolderId,
                               boolean includeMountFolders)
                        throws PortalException,
                               SystemException
Returns all immediate subfolders of the parent folder, optionally including mount folders for third-party repositories.

Specified by:
getFolders in interface DLAppService
Parameters:
repositoryId - the primary key of the folder's repository
parentFolderId - the primary key of the folder's parent folder
includeMountFolders - whether to include mount folders for third-party repositories
Returns:
the immediate subfolders of the parent folder
Throws:
PortalException - if the parent folder could not be found
SystemException - if a system exception occurred

getFolders

public List<Folder> getFolders(long repositoryId,
                               long parentFolderId,
                               boolean includeMountFolders,
                               int start,
                               int end)
                        throws PortalException,
                               SystemException
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.

Specified by:
getFolders in interface DLAppService
Parameters:
repositoryId - the primary key of the folder's repository
parentFolderId - the primary key of the folder's parent folder
includeMountFolders - whether to include mount folders for third-party repositories
start - the lower bound of the range of results
end - the upper bound of the range of results (not inclusive)
Returns:
the name-ordered range of immediate subfolders of the parent folder
Throws:
PortalException - if the parent folder could not be found
SystemException - if a system exception occurred

getFolders

public List<Folder> getFolders(long repositoryId,
                               long parentFolderId,
                               boolean includeMountFolders,
                               int start,
                               int end,
                               OrderByComparator obc)
                        throws PortalException,
                               SystemException
Returns an ordered range of all the immediate subfolders of the parent folder.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Specified by:
getFolders in interface DLAppService
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 - if the parent folder could not be found
SystemException - if a system exception occurred

getFolders

public List<Folder> getFolders(long repositoryId,
                               long parentFolderId,
                               int status,
                               boolean includeMountFolders,
                               int start,
                               int end,
                               OrderByComparator obc)
                        throws PortalException,
                               SystemException
Returns an ordered range of all the immediate subfolders of the parent folder.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Specified by:
getFolders in interface DLAppService
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 - if the parent folder could not be found
SystemException - if a system exception occurred

getFolders

public List<Folder> getFolders(long repositoryId,
                               long parentFolderId,
                               int start,
                               int end)
                        throws PortalException,
                               SystemException
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.

Specified by:
getFolders in interface DLAppService
Parameters:
repositoryId - the primary key of the folder's repository
parentFolderId - the primary key of the folder's parent folder
start - the lower bound of the range of results
end - the upper bound of the range of results (not inclusive)
Returns:
the name-ordered range of immediate subfolders of the parent folder
Throws:
PortalException - if the parent folder could not be found
SystemException - if a system exception occurred

getFolders

public List<Folder> getFolders(long repositoryId,
                               long parentFolderId,
                               int start,
                               int end,
                               OrderByComparator obc)
                        throws PortalException,
                               SystemException
Returns an ordered range of all the immediate subfolders of the parent folder.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Specified by:
getFolders in interface DLAppService
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 - if the parent folder could not be found
SystemException - if a system exception occurred

getFoldersAndFileEntriesAndFileShortcuts

public List<Object> getFoldersAndFileEntriesAndFileShortcuts(long repositoryId,
                                                             long folderId,
                                                             int status,
                                                             boolean includeMountFolders,
                                                             int start,
                                                             int end)
                                                      throws PortalException,
                                                             SystemException
Returns a name-ordered range of all the immediate subfolders, file entries, and file shortcuts in the parent folder.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Specified by:
getFoldersAndFileEntriesAndFileShortcuts in interface DLAppService
Parameters:
repositoryId - the primary key of the repository
folderId - the primary key of the parent folder
status - the workflow status
includeMountFolders - whether to include mount folders for third-party repositories
start - the lower bound of the range of results
end - the upper bound of the range of results (not inclusive)
Returns:
the name-ordered range of immediate subfolders, file entries, and file shortcuts in the parent folder
Throws:
PortalException - if the parent folder could not be found
SystemException - if a system exception occurred

getFoldersAndFileEntriesAndFileShortcuts

public List<Object> getFoldersAndFileEntriesAndFileShortcuts(long repositoryId,
                                                             long folderId,
                                                             int status,
                                                             boolean includeMountFolders,
                                                             int start,
                                                             int end,
                                                             OrderByComparator obc)
                                                      throws PortalException,
                                                             SystemException
Returns an ordered range of all the immediate subfolders, file entries, and file shortcuts in the parent folder.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Specified by:
getFoldersAndFileEntriesAndFileShortcuts in interface DLAppService
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 - if the parent folder could not be found
SystemException - if a system exception occurred

getFoldersAndFileEntriesAndFileShortcuts

public List<Object> getFoldersAndFileEntriesAndFileShortcuts(long repositoryId,
                                                             long folderId,
                                                             int status,
                                                             String[] mimeTypes,
                                                             boolean includeMountFolders,
                                                             int start,
                                                             int end,
                                                             OrderByComparator obc)
                                                      throws PortalException,
                                                             SystemException
Specified by:
getFoldersAndFileEntriesAndFileShortcuts in interface DLAppService
Throws:
PortalException
SystemException

getFoldersAndFileEntriesAndFileShortcutsCount

public int getFoldersAndFileEntriesAndFileShortcutsCount(long repositoryId,
                                                         long folderId,
                                                         int status,
                                                         boolean includeMountFolders)
                                                  throws PortalException,
                                                         SystemException
Returns the number of immediate subfolders, file entries, and file shortcuts in the parent folder.

Specified by:
getFoldersAndFileEntriesAndFileShortcutsCount in interface DLAppService
Parameters:
repositoryId - the primary key of the repository
folderId - the primary key of the parent folder
status - the workflow status
includeMountFolders - whether to include mount folders for third-party repositories
Returns:
the number of immediate subfolders, file entries, and file shortcuts in the parent folder
Throws:
PortalException - if the folder could not be found
SystemException - if a system exception occurred

getFoldersAndFileEntriesAndFileShortcutsCount

public int getFoldersAndFileEntriesAndFileShortcutsCount(long repositoryId,
                                                         long folderId,
                                                         int status,
                                                         String[] mimeTypes,
                                                         boolean includeMountFolders)
                                                  throws PortalException,
                                                         SystemException
Specified by:
getFoldersAndFileEntriesAndFileShortcutsCount in interface DLAppService
Throws:
PortalException
SystemException

getFoldersCount

public int getFoldersCount(long repositoryId,
                           long parentFolderId)
                    throws PortalException,
                           SystemException
Returns the number of immediate subfolders of the parent folder.

Specified by:
getFoldersCount in interface DLAppService
Parameters:
repositoryId - the primary key of the folder's repository
parentFolderId - the primary key of the folder's parent folder
Returns:
the number of immediate subfolders of the parent folder
Throws:
PortalException - if the parent folder could not be found
SystemException - if a system exception occurred

getFoldersCount

public int getFoldersCount(long repositoryId,
                           long parentFolderId,
                           boolean includeMountFolders)
                    throws PortalException,
                           SystemException
Returns the number of immediate subfolders of the parent folder, optionally including mount folders for third-party repositories.

Specified by:
getFoldersCount in interface DLAppService
Parameters:
repositoryId - the primary key of the folder's repository
parentFolderId - the primary key of the folder's parent folder
includeMountFolders - whether to include mount folders for third-party repositories
Returns:
the number of immediate subfolders of the parent folder
Throws:
PortalException - if the parent folder could not be found
SystemException - if a system exception occurred

getFoldersCount

public int getFoldersCount(long repositoryId,
                           long parentFolderId,
                           int status,
                           boolean includeMountFolders)
                    throws PortalException,
                           SystemException
Returns the number of immediate subfolders of the parent folder, optionally including mount folders for third-party repositories.

Specified by:
getFoldersCount in interface DLAppService
Parameters:
repositoryId - the primary key of the folder's repository
parentFolderId - the primary key of the folder's parent folder
status - the workflow status
includeMountFolders - whether to include mount folders for third-party repositories
Returns:
the number of immediate subfolders of the parent folder
Throws:
PortalException - if the parent folder could not be found
SystemException - if a system exception occurred

getFoldersFileEntriesCount

public int getFoldersFileEntriesCount(long repositoryId,
                                      List<Long> folderIds,
                                      int status)
                               throws PortalException,
                                      SystemException
Returns the number of immediate subfolders and file entries across the folders.

Specified by:
getFoldersFileEntriesCount in interface DLAppService
Parameters:
repositoryId - the primary key of the repository
folderIds - the primary keys of folders from which to count immediate subfolders and file entries
status - the workflow status
Returns:
the number of immediate subfolders and file entries across the folders
Throws:
PortalException - if the repository could not be found
SystemException - if a system exception occurred

getGroupFileEntries

public List<FileEntry> getGroupFileEntries(long groupId,
                                           long userId,
                                           int start,
                                           int end)
                                    throws PortalException,
                                           SystemException
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.

Specified by:
getGroupFileEntries in interface DLAppService
Parameters:
groupId - the primary key of the group
userId - the primary key of the user who created the file (optionally 0)
start - the lower bound of the range of results
end - the upper bound of the range of results (not inclusive)
Returns:
the range of matching file entries ordered by date modified
Throws:
PortalException - if the group could not be found
SystemException - if a system exception occurred

getGroupFileEntries

public List<FileEntry> getGroupFileEntries(long groupId,
                                           long userId,
                                           int start,
                                           int end,
                                           OrderByComparator obc)
                                    throws PortalException,
                                           SystemException
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.

Specified by:
getGroupFileEntries in interface DLAppService
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 - if the group could not be found
SystemException - if a system exception occurred

getGroupFileEntries

public List<FileEntry> getGroupFileEntries(long groupId,
                                           long userId,
                                           long rootFolderId,
                                           int start,
                                           int end)
                                    throws PortalException,
                                           SystemException
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.

Specified by:
getGroupFileEntries in interface DLAppService
Parameters:
groupId - the primary key of the group
userId - the primary key of the user who created the file (optionally 0)
rootFolderId - the primary key of the root folder to begin the search
start - the lower bound of the range of results
end - the upper bound of the range of results (not inclusive)
Returns:
the range of matching file entries ordered by date modified
Throws:
PortalException - if the group could not be found
SystemException - if a system exception occurred

getGroupFileEntries

public List<FileEntry> getGroupFileEntries(long groupId,
                                           long userId,
                                           long rootFolderId,
                                           int start,
                                           int end,
                                           OrderByComparator obc)
                                    throws PortalException,
                                           SystemException
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.

Specified by:
getGroupFileEntries in interface DLAppService
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 - if the group could not be found
SystemException - if a system exception occurred

getGroupFileEntries

public List<FileEntry> getGroupFileEntries(long groupId,
                                           long userId,
                                           long rootFolderId,
                                           String[] mimeTypes,
                                           int status,
                                           int start,
                                           int end,
                                           OrderByComparator obc)
                                    throws PortalException,
                                           SystemException
Specified by:
getGroupFileEntries in interface DLAppService
Throws:
PortalException
SystemException

getGroupFileEntriesCount

public int getGroupFileEntriesCount(long groupId,
                                    long userId)
                             throws PortalException,
                                    SystemException
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.

Specified by:
getGroupFileEntriesCount in interface DLAppService
Parameters:
groupId - the primary key of the group
userId - the primary key of the user who created the file (optionally 0)
Returns:
the number of matching file entries
Throws:
PortalException - if the group could not be found
SystemException - if a system exception occurred

getGroupFileEntriesCount

public int getGroupFileEntriesCount(long groupId,
                                    long userId,
                                    long rootFolderId)
                             throws PortalException,
                                    SystemException
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.

Specified by:
getGroupFileEntriesCount in interface DLAppService
Parameters:
groupId - the primary key of the group
userId - the primary key of the user who created the file (optionally 0)
rootFolderId - the primary key of the root folder to begin the search
Returns:
the number of matching file entries
Throws:
PortalException - if the group could not be found
SystemException - if a system exception occurred

getGroupFileEntriesCount

public int getGroupFileEntriesCount(long groupId,
                                    long userId,
                                    long rootFolderId,
                                    String[] mimeTypes,
                                    int status)
                             throws PortalException,
                                    SystemException
Specified by:
getGroupFileEntriesCount in interface DLAppService
Throws:
PortalException
SystemException

getMountFolders

public List<Folder> getMountFolders(long repositoryId,
                                    long parentFolderId)
                             throws PortalException,
                                    SystemException
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.

Specified by:
getMountFolders in interface DLAppService
Parameters:
repositoryId - the primary key of the folder's repository
parentFolderId - the primary key of the folder's parent folder
Returns:
the immediate subfolders of the parent folder that are used for mounting third-party repositories
Throws:
PortalException - if the repository or parent folder could not be found
SystemException - if a system exception occurred

getMountFolders

public List<Folder> getMountFolders(long repositoryId,
                                    long parentFolderId,
                                    int start,
                                    int end)
                             throws PortalException,
                                    SystemException
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.

Specified by:
getMountFolders in interface DLAppService
Parameters:
repositoryId - the primary key of the repository
parentFolderId - the primary key of the parent folder
start - the lower bound of the range of results
end - the upper bound of the range of results (not inclusive)
Returns:
the name-ordered range of immediate subfolders of the parent folder that are used for mounting third-party repositories
Throws:
PortalException - if the repository or parent folder could not be found
SystemException - if a system exception occurred

getMountFolders

public List<Folder> getMountFolders(long repositoryId,
                                    long parentFolderId,
                                    int start,
                                    int end,
                                    OrderByComparator obc)
                             throws PortalException,
                                    SystemException
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.

Specified by:
getMountFolders in interface DLAppService
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 - if the repository or parent folder could not be found
SystemException - if a system exception occurred

getMountFoldersCount

public int getMountFoldersCount(long repositoryId,
                                long parentFolderId)
                         throws PortalException,
                                SystemException
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.

Specified by:
getMountFoldersCount in interface DLAppService
Parameters:
repositoryId - the primary key of the repository
parentFolderId - the primary key of the parent folder
Returns:
the number of folders of the parent folder that are used for mounting third-party repositories
Throws:
PortalException - if the repository or parent folder could not be found
SystemException - if a system exception occurred

getSubfolderIds

public void getSubfolderIds(long repositoryId,
                            List<Long> folderIds,
                            long folderId)
                     throws PortalException,
                            SystemException
Specified by:
getSubfolderIds in interface DLAppService
Throws:
PortalException
SystemException

getSubfolderIds

public List<Long> getSubfolderIds(long repositoryId,
                                  long folderId)
                           throws PortalException,
                                  SystemException
Returns all the descendant folders of the folder with the primary key.

Specified by:
getSubfolderIds in interface DLAppService
Parameters:
repositoryId - the primary key of the repository
folderId - the primary key of the folder
Returns:
the descendant folders of the folder with the primary key
Throws:
PortalException - if the repository or parent folder could not be found
SystemException - if a system exception occurred

getSubfolderIds

public List<Long> getSubfolderIds(long repositoryId,
                                  long folderId,
                                  boolean recurse)
                           throws PortalException,
                                  SystemException
Returns descendant folders of the folder with the primary key, optionally limiting to one level deep.

Specified by:
getSubfolderIds in interface DLAppService
Parameters:
repositoryId - the primary key of the repository
folderId - the primary key of the folder
recurse - whether to recurse through each subfolder
Returns:
the descendant folders of the folder with the primary key
Throws:
PortalException - if the repository or parent folder could not be found
SystemException - if a system exception occurred

getTempFileEntryNames

public String[] getTempFileEntryNames(long groupId,
                                      long folderId,
                                      String tempFolderName)
                               throws PortalException,
                                      SystemException
Returns all the temporary file entry names.

Specified by:
getTempFileEntryNames in interface DLAppService
Parameters:
groupId - the primary key of the group
folderId - the primary key of the folder where the file entry will eventually reside
tempFolderName - the temporary folder's name
Returns:
the temporary file entry names
Throws:
PortalException - if the folder was invalid
SystemException - if a system exception occurred
See Also:
addTempFileEntry(long, long, String, String, File, String), TempFileUtil

lockFileEntry

public Lock lockFileEntry(long fileEntryId)
                   throws PortalException,
                          SystemException
Deprecated. As of 6.2.0, replaced by checkOutFileEntry(long, ServiceContext)

Specified by:
lockFileEntry in interface DLAppService
Throws:
PortalException
SystemException

lockFileEntry

public Lock lockFileEntry(long fileEntryId,
                          String owner,
                          long expirationTime)
                   throws PortalException,
                          SystemException
Deprecated. As of 6.2.0, replaced by checkOutFileEntry(long, String, long, ServiceContext)

Specified by:
lockFileEntry in interface DLAppService
Throws:
PortalException
SystemException

lockFolder

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

Specified by:
lockFolder in interface DLAppService
Parameters:
repositoryId - the primary key of the repository
folderId - the primary key of the folder
Returns:
the lock object
Throws:
PortalException - if the repository or folder could not be found
SystemException - if a system exception occurred

lockFolder

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

Specified by:
lockFolder in interface DLAppService
Parameters:
repositoryId - the primary key of the repository
folderId - the primary key of the folder
owner - the owner string for the checkout (optionally null)
inheritable - whether the lock must propagate to descendants
expirationTime - the time in milliseconds before the lock expires. If the value is 0, the default expiration time will be used from portal.properties>.
Returns:
the lock object
Throws:
PortalException - if the repository or folder could not be found
SystemException - if a system exception occurred

moveFileEntry

public FileEntry moveFileEntry(long fileEntryId,
                               long newFolderId,
                               ServiceContext serviceContext)
                        throws PortalException,
                               SystemException
Moves the file entry to the new folder.

Specified by:
moveFileEntry in interface DLAppService
Parameters:
fileEntryId - the primary key of the file entry
newFolderId - the primary key of the new folder
serviceContext - the service context to be applied
Returns:
the file entry
Throws:
PortalException - if the file entry or the new folder could not be found
SystemException - if a system exception occurred

moveFileEntryFromTrash

public FileEntry moveFileEntryFromTrash(long fileEntryId,
                                        long newFolderId,
                                        ServiceContext serviceContext)
                                 throws PortalException,
                                        SystemException
Moves the file entry from a trashed folder to the new folder.

Specified by:
moveFileEntryFromTrash in interface DLAppService
Parameters:
fileEntryId - the primary key of the file entry
newFolderId - the primary key of the new folder
serviceContext - the service context to be applied
Returns:
the file entry
Throws:
PortalException - if the file entry or the new folder could not be found
SystemException - if a system exception occurred

moveFileEntryToTrash

public FileEntry moveFileEntryToTrash(long fileEntryId)
                               throws PortalException,
                                      SystemException
Moves the file entry with the primary key to the trash portlet.

Specified by:
moveFileEntryToTrash in interface DLAppService
Parameters:
fileEntryId - the primary key of the file entry
Returns:
the file entry
Throws:
PortalException - if the file entry could not be found
SystemException - if a system exception occurred

moveFileShortcutFromTrash

public DLFileShortcut moveFileShortcutFromTrash(long fileShortcutId,
                                                long newFolderId,
                                                ServiceContext serviceContext)
                                         throws PortalException,
                                                SystemException
Moves the file shortcut from a trashed folder to the new folder.

Specified by:
moveFileShortcutFromTrash in interface DLAppService
Parameters:
fileShortcutId - the primary key of the file shortcut
newFolderId - the primary key of the new folder
serviceContext - the service context to be applied
Returns:
the file shortcut
Throws:
PortalException - if the file entry or the new folder could not be found
SystemException - if a system exception occurred

moveFileShortcutToTrash

public DLFileShortcut moveFileShortcutToTrash(long fileShortcutId)
                                       throws PortalException,
                                              SystemException
Moves the file shortcut with the primary key to the trash portlet.

Specified by:
moveFileShortcutToTrash in interface DLAppService
Parameters:
fileShortcutId - the primary key of the file shortcut
Returns:
the file shortcut
Throws:
PortalException - if the file shortcut could not be found
SystemException - if a system exception occurred

moveFolder

public Folder moveFolder(long folderId,
                         long parentFolderId,
                         ServiceContext serviceContext)
                  throws PortalException,
                         SystemException
Moves the folder to the new parent folder with the primary key.

Specified by:
moveFolder in interface DLAppService
Parameters:
folderId - the primary key of the folder
parentFolderId - the primary key of the new parent folder
serviceContext - the service context to be applied
Returns:
the file entry
Throws:
PortalException - if the folder could not be found
SystemException - if a system exception occurred

moveFolderFromTrash

public Folder moveFolderFromTrash(long folderId,
                                  long parentFolderId,
                                  ServiceContext serviceContext)
                           throws PortalException,
                                  SystemException
Moves the folder with the primary key from the trash portlet to the new parent folder with the primary key.

Specified by:
moveFolderFromTrash in interface DLAppService
Parameters:
folderId - the primary key of the folder
parentFolderId - the primary key of the new parent folder
serviceContext - the service context to be applied
Returns:
the file entry
Throws:
PortalException - if the folder could not be found
SystemException - if a system exception occurred

moveFolderToTrash

public Folder moveFolderToTrash(long folderId)
                         throws PortalException,
                                SystemException
Moves the folder with the primary key to the trash portlet.

Specified by:
moveFolderToTrash in interface DLAppService
Parameters:
folderId - the primary key of the folder
Returns:
the file entry
Throws:
PortalException - if the folder could not be found
SystemException - if a system exception occurred

refreshFileEntryLock

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

Specified by:
refreshFileEntryLock in interface DLAppService
Parameters:
lockUuid - the lock's UUID
companyId - the primary key of the file entry's company
expirationTime - the time in milliseconds before the lock expires. If the value is 0, the default expiration time will be used from portal.properties>.
Returns:
the lock object
Throws:
PortalException - if the file entry or lock could not be found
SystemException - if a system exception occurred

refreshFolderLock

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

Specified by:
refreshFolderLock in interface DLAppService
Parameters:
lockUuid - the lock's UUID
companyId - the primary key of the file entry's company
expirationTime - the time in milliseconds before the lock expires. If the value is 0, the default expiration time will be used from portal.properties>.
Returns:
the lock object
Throws:
PortalException - if the folder or lock could not be found
SystemException - if a system exception occurred

restoreFileEntryFromTrash

public void restoreFileEntryFromTrash(long fileEntryId)
                               throws PortalException,
                                      SystemException
Restores the file entry with the primary key from the trash portlet.

Specified by:
restoreFileEntryFromTrash in interface DLAppService
Parameters:
fileEntryId - the primary key of the file entry
Throws:
PortalException - if the file entry could not be found
SystemException - if a system exception occurred

restoreFileShortcutFromTrash

public void restoreFileShortcutFromTrash(long fileShortcutId)
                                  throws PortalException,
                                         SystemException
Restores the file shortcut with the primary key from the trash portlet.

Specified by:
restoreFileShortcutFromTrash in interface DLAppService
Parameters:
fileShortcutId - the primary key of the file shortcut
Throws:
PortalException - if the file shortcut could not be found
SystemException - if a system exception occurred

restoreFolderFromTrash

public void restoreFolderFromTrash(long folderId)
                            throws PortalException,
                                   SystemException
Restores the folder with the primary key from the trash portlet.

Specified by:
restoreFolderFromTrash in interface DLAppService
Parameters:
folderId - the primary key of the folder
Throws:
PortalException - if the folder could not be found
SystemException - if a system exception occurred

revertFileEntry

public void revertFileEntry(long fileEntryId,
                            String version,
                            ServiceContext serviceContext)
                     throws PortalException,
                            SystemException
Reverts the file entry to a previous version. A new version will be created based on the previous version and metadata.

Specified by:
revertFileEntry in interface DLAppService
Parameters:
fileEntryId - the primary key of the file entry
version - the version to revert back to
serviceContext - the service context to be applied
Throws:
PortalException - if the file entry or version could not be found
SystemException - if a system exception occurred

search

public Hits search(long repositoryId,
                   long creatorUserId,
                   int status,
                   int start,
                   int end)
            throws PortalException,
                   SystemException
Specified by:
search in interface DLAppService
Throws:
PortalException
SystemException

search

public Hits search(long repositoryId,
                   long creatorUserId,
                   long folderId,
                   String[] mimeTypes,
                   int status,
                   int start,
                   int end)
            throws PortalException,
                   SystemException
Specified by:
search in interface DLAppService
Throws:
PortalException
SystemException

search

public Hits search(long repositoryId,
                   SearchContext searchContext)
            throws SearchException
Specified by:
search in interface DLAppService
Throws:
SearchException

search

public Hits search(long repositoryId,
                   SearchContext searchContext,
                   Query query)
            throws SearchException
Specified by:
search in interface DLAppService
Throws:
SearchException

subscribeFileEntryType

public void subscribeFileEntryType(long groupId,
                                   long fileEntryTypeId)
                            throws PortalException,
                                   SystemException
Subscribe the user to changes in documents of the file entry type. This method is only supported by the Liferay repository.

Specified by:
subscribeFileEntryType in interface DLAppService
Parameters:
groupId - the primary key of the file entry type's group
fileEntryTypeId - the primary key of the file entry type
Throws:
PortalException - if the user or group could not be found, or if subscribing was not permissible
SystemException - if a system exception occurred

subscribeFolder

public void subscribeFolder(long groupId,
                            long folderId)
                     throws PortalException,
                            SystemException
Subscribe the user to document changes in the folder. This method is only supported by the Liferay repository.

Specified by:
subscribeFolder in interface DLAppService
Parameters:
groupId - the primary key of the folder's group
folderId - the primary key of the folder
Throws:
PortalException - if the user or group could not be found, or if subscribing was not permissible
SystemException - if a system exception occurred

unlockFileEntry

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

Specified by:
unlockFileEntry in interface DLAppService
Throws:
PortalException
SystemException

unlockFileEntry

public void unlockFileEntry(long fileEntryId,
                            String lockUuid)
                     throws PortalException,
                            SystemException
Deprecated. As of 6.2.0, replaced by checkInFileEntry(long, String).

Specified by:
unlockFileEntry in interface DLAppService
Throws:
PortalException
SystemException

unlockFolder

public void unlockFolder(long repositoryId,
                         long folderId,
                         String lockUuid)
                  throws PortalException,
                         SystemException
Unlocks the folder. This method is primarily used by WebDAV.

Specified by:
unlockFolder in interface DLAppService
Parameters:
repositoryId - the primary key of the repository
folderId - the primary key of the folder
lockUuid - the lock's UUID
Throws:
PortalException - if the repository or folder could not be found
SystemException - if a system exception occurred

unlockFolder

public void unlockFolder(long repositoryId,
                         long parentFolderId,
                         String name,
                         String lockUuid)
                  throws PortalException,
                         SystemException
Unlocks the folder. This method is primarily used by WebDAV.

Specified by:
unlockFolder in interface DLAppService
Parameters:
repositoryId - the primary key of the repository
parentFolderId - the primary key of the parent folder
name - the folder's name
lockUuid - the lock's UUID
Throws:
PortalException - if the repository or folder could not be found
SystemException - if a system exception occurred

unsubscribeFileEntryType

public void unsubscribeFileEntryType(long groupId,
                                     long fileEntryTypeId)
                              throws PortalException,
                                     SystemException
Unsubscribe the user from changes in documents of the file entry type. This method is only supported by the Liferay repository.

Specified by:
unsubscribeFileEntryType in interface DLAppService
Parameters:
groupId - the primary key of the file entry type's group
fileEntryTypeId - the primary key of the file entry type
Throws:
PortalException - if the user or group could not be found, or if unsubscribing was not permissible
SystemException - if a system exception occurred

unsubscribeFolder

public void unsubscribeFolder(long groupId,
                              long folderId)
                       throws PortalException,
                              SystemException
Unsubscribe the user from document changes in the folder. This method is only supported by the Liferay repository.

Specified by:
unsubscribeFolder in interface DLAppService
Parameters:
groupId - the primary key of the folder's group
folderId - the primary key of the folder
Throws:
PortalException - if the user or group could not be found, or if unsubscribing was not permissible
SystemException - if a system exception occurred

updateFileEntry

public FileEntry updateFileEntry(long fileEntryId,
                                 String sourceFileName,
                                 String mimeType,
                                 String title,
                                 String description,
                                 String changeLog,
                                 boolean majorVersion,
                                 byte[] bytes,
                                 ServiceContext serviceContext)
                          throws PortalException,
                                 SystemException
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.

Specified by:
updateFileEntry in interface DLAppService
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 - if the file entry could not be found
SystemException - if a system exception occurred

updateFileEntry

public FileEntry updateFileEntry(long fileEntryId,
                                 String sourceFileName,
                                 String mimeType,
                                 String title,
                                 String description,
                                 String changeLog,
                                 boolean majorVersion,
                                 File file,
                                 ServiceContext serviceContext)
                          throws PortalException,
                                 SystemException
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.

Specified by:
updateFileEntry in interface DLAppService
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 - if the file entry could not be found
SystemException - if a system exception occurred

updateFileEntry

public FileEntry updateFileEntry(long fileEntryId,
                                 String sourceFileName,
                                 String mimeType,
                                 String title,
                                 String description,
                                 String changeLog,
                                 boolean majorVersion,
                                 InputStream is,
                                 long size,
                                 ServiceContext serviceContext)
                          throws PortalException,
                                 SystemException
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.

Specified by:
updateFileEntry in interface DLAppService
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 - if the file entry could not be found
SystemException - if a system exception occurred

updateFileEntryAndCheckIn

public FileEntry updateFileEntryAndCheckIn(long fileEntryId,
                                           String sourceFileName,
                                           String mimeType,
                                           String title,
                                           String description,
                                           String changeLog,
                                           boolean majorVersion,
                                           File file,
                                           ServiceContext serviceContext)
                                    throws PortalException,
                                           SystemException
Specified by:
updateFileEntryAndCheckIn in interface DLAppService
Throws:
PortalException
SystemException

updateFileEntryAndCheckIn

public FileEntry updateFileEntryAndCheckIn(long fileEntryId,
                                           String sourceFileName,
                                           String mimeType,
                                           String title,
                                           String description,
                                           String changeLog,
                                           boolean majorVersion,
                                           InputStream is,
                                           long size,
                                           ServiceContext serviceContext)
                                    throws PortalException,
                                           SystemException
Specified by:
updateFileEntryAndCheckIn in interface DLAppService
Throws:
PortalException
SystemException

updateFileShortcut

public DLFileShortcut updateFileShortcut(long fileShortcutId,
                                         long folderId,
                                         long toFileEntryId,
                                         ServiceContext serviceContext)
                                  throws PortalException,
                                         SystemException
Updates a file shortcut to the existing file entry. This method is only supported by the Liferay repository.

Specified by:
updateFileShortcut in interface DLAppService
Parameters:
fileShortcutId - the primary key of the file shortcut
folderId - the primary key of the file shortcut's parent folder
toFileEntryId - the primary key of the file shortcut's file entry
serviceContext - the service context to be applied. Can set the asset category IDs, asset tag names, and expando bridge attributes for the file entry.
Returns:
the file shortcut
Throws:
PortalException - if the file shortcut, folder, or file entry could not be found
SystemException - if a system exception occurred

updateFolder

public Folder updateFolder(long folderId,
                           String name,
                           String description,
                           ServiceContext serviceContext)
                    throws PortalException,
                           SystemException
Updates the folder.

Specified by:
updateFolder in interface DLAppService
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
  • overrideFileEntryTypes - boolean specifying whether to override ancestral folder's restriction of file entry types allowed
  • workflowDefinitionXYZ - the workflow definition name specified per file entry type. The parameter name must be the string workflowDefinition appended by the fileEntryTypeId (optionally 0).
Returns:
the folder
Throws:
PortalException - if the current or new parent folder could not be found or if the new parent folder's information was invalid
SystemException - if a system exception occurred

verifyFileEntryCheckOut

public boolean verifyFileEntryCheckOut(long repositoryId,
                                       long fileEntryId,
                                       String lockUuid)
                                throws PortalException,
                                       SystemException
Returns true if the file entry is checked out. This method is primarily used by WebDAV.

Specified by:
verifyFileEntryCheckOut in interface DLAppService
Parameters:
repositoryId - the primary key for the repository
fileEntryId - the primary key for the file entry
lockUuid - the lock's UUID
Returns:
true if the file entry is checked out; false otherwise
Throws:
PortalException - if the file entry could not be found
SystemException - if a system exception occurred

verifyFileEntryLock

public boolean verifyFileEntryLock(long repositoryId,
                                   long fileEntryId,
                                   String lockUuid)
                            throws PortalException,
                                   SystemException
Specified by:
verifyFileEntryLock in interface DLAppService
Throws:
PortalException
SystemException

verifyInheritableLock

public boolean verifyInheritableLock(long repositoryId,
                                     long folderId,
                                     String lockUuid)
                              throws PortalException,
                                     SystemException
Returns true if the inheritable lock exists. This method is primarily used by WebDAV.

Specified by:
verifyInheritableLock in interface DLAppService
Parameters:
repositoryId - the primary key for the repository
folderId - the primary key for the folder
lockUuid - the lock's UUID
Returns:
true if the inheritable lock exists; false otherwise
Throws:
PortalException - if the folder could not be found
SystemException - if a system exception occurred

getWrappedDLAppService

public DLAppService getWrappedDLAppService()
Deprecated. As of 6.1.0, replaced by getWrappedService()


setWrappedDLAppService

public void setWrappedDLAppService(DLAppService dlAppService)
Deprecated. As of 6.1.0, replaced by setWrappedService(com.liferay.portlet.documentlibrary.service.DLAppService)


getWrappedService

public DLAppService getWrappedService()
Specified by:
getWrappedService in interface ServiceWrapper<DLAppService>

setWrappedService

public void setWrappedService(DLAppService dlAppService)
Specified by:
setWrappedService in interface ServiceWrapper<DLAppService>

Liferay 6.2-ce-ga5