|
Liferay 6.2.0-ce-m4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.portlet.documentlibrary.service.DLAppServiceWrapper
public class DLAppServiceWrapper
This class is a wrapper for DLAppService.
DLAppService| 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)
|
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. 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 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 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<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 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 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 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 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. Renamed to getWrappedService() |
DLAppService |
getWrappedService()
|
Lock |
lockFileEntry(long fileEntryId)
Deprecated. checkOutFileEntry(long, ServiceContext) |
Lock |
lockFileEntry(long fileEntryId,
String owner,
long expirationTime)
Deprecated. 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,
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. Renamed to 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. Use checkInFileEntry(long, boolean, String,
ServiceContext). |
void |
unlockFileEntry(long fileEntryId,
String lockUuid)
Deprecated. Use 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 {@link java.io. |
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 |
|---|
public DLAppServiceWrapper(DLAppService dlAppService)
| Method Detail |
|---|
public String getBeanIdentifier()
getBeanIdentifier in interface DLAppServicepublic void setBeanIdentifier(String beanIdentifier)
setBeanIdentifier in interface DLAppServicebeanIdentifier - the Spring bean ID for this bean
public FileEntry addFileEntry(long repositoryId,
long folderId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
byte[] bytes,
ServiceContext serviceContext)
throws PortalException,
SystemException
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.
addFileEntry in interface DLAppServicerepositoryId - the primary key of the repositoryfolderId - the primary key of the file entry's parent foldersourceFileName - the original file's namemimeType - the file's MIME typetitle - the name to be assigned to the file (optionally null
)description - the file's descriptionchangeLog - the file's version change logbytes - the file's data (optionally null)serviceContext - the service context to be applied. Can set the
asset category IDs, asset tag names, and expando bridge
attributes for the file entry. In a Liferay repository, it may
include: PortalException - if the parent folder could not be found or if the
file entry's information was invalid
SystemException - if a system exception occurred
public FileEntry addFileEntry(long repositoryId,
long folderId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
File file,
ServiceContext serviceContext)
throws PortalException,
SystemException
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.
addFileEntry in interface DLAppServicerepositoryId - the primary key of the repositoryfolderId - the primary key of the file entry's parent foldersourceFileName - the original file's namemimeType - the file's MIME typetitle - the name to be assigned to the file (optionally null
)description - the file's descriptionchangeLog - the file's version change logfile - the file's data (optionally null)serviceContext - the service context to be applied. Can set the
asset category IDs, asset tag names, and expando bridge
attributes for the file entry. In a Liferay repository, it may
include: PortalException - if the parent folder could not be found or if the
file entry's information was invalid
SystemException - if a system exception occurred
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
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.
addFileEntry in interface DLAppServicerepositoryId - the primary key of the repositoryfolderId - the primary key of the file entry's parent foldersourceFileName - the original file's namemimeType - the file's MIME typetitle - the name to be assigned to the file (optionally null
)description - the file's descriptionchangeLog - the file's version change logis - 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: PortalException - if the parent folder could not be found or if the
file entry's information was invalid
SystemException - if a system exception occurred
public DLFileShortcut addFileShortcut(long repositoryId,
long folderId,
long toFileEntryId,
ServiceContext serviceContext)
throws PortalException,
SystemException
addFileShortcut in interface DLAppServicerepositoryId - the primary key of the repositoryfolderId - the primary key of the file shortcut's parent foldertoFileEntryId - the primary key of the file shortcut's file entryserviceContext - the service context to be applied. Can set the
asset category IDs, asset tag names, and expando bridge
attributes for the file entry.
PortalException - if the parent folder or file entry could not be
found, or if the file shortcut's information was invalid
SystemException - if a system exception occurred
public Folder addFolder(long repositoryId,
long parentFolderId,
String name,
String description,
ServiceContext serviceContext)
throws PortalException,
SystemException
addFolder in interface DLAppServicerepositoryId - the primary key of the repositoryparentFolderId - the primary key of the folder's parent foldername - the folder's namedescription - the folder's descriptionserviceContext - the service context to be applied. In a Liferay
repository, it may include boolean mountPoint specifying whether
folder is a facade for mounting a third-party repository
PortalException - if the parent folder could not be found or if the
new folder's information was invalid
SystemException - if a system exception occurred
public FileEntry addTempFileEntry(long groupId,
long folderId,
String fileName,
String tempFolderName,
File file,
String mimeType)
throws PortalException,
SystemException
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.
addTempFileEntry in interface DLAppServicegroupId - the primary key of the groupfolderId - the primary key of the folder where the file entry will
eventually residefileName - the file's original nametempFolderName - the temporary folder's namefile - Name the file's original namemimeType - the file's MIME type
PortalException - if the file name was invalid
SystemException - if a system exception occurredTempFileUtil
public FileEntry addTempFileEntry(long groupId,
long folderId,
String fileName,
String tempFolderName,
InputStream inputStream,
String mimeType)
throws PortalException,
SystemException
addTempFileEntry in interface DLAppServicePortalException
SystemException
public void cancelCheckOut(long fileEntryId)
throws PortalException,
SystemException
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.
cancelCheckOut in interface DLAppServicefileEntryId - the primary key of the file entry to cancel the
checkout
PortalException - if the file entry could not be found
SystemException - if a system exception occurredcheckInFileEntry(long, boolean, String, ServiceContext),
checkOutFileEntry(long, ServiceContext)
public void checkInFileEntry(long fileEntryId,
boolean majorVersion,
String changeLog,
ServiceContext serviceContext)
throws PortalException,
SystemException
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.
checkInFileEntry in interface DLAppServicefileEntryId - the primary key of the file entry to check inmajorVersion - whether the new file version is a major versionchangeLog - the file's version change logserviceContext - the service context to be applied
PortalException - if the file entry could not be found
SystemException - if a system exception occurredcancelCheckOut(long),
checkOutFileEntry(long, ServiceContext)
public void checkInFileEntry(long fileEntryId,
String lockUuid)
throws PortalException,
SystemException
checkInFileEntry(long, String, ServiceContext)
checkInFileEntry in interface DLAppServicePortalException
SystemException
public void checkInFileEntry(long fileEntryId,
String lockUuid,
ServiceContext serviceContext)
throws PortalException,
SystemException
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.
checkInFileEntry in interface DLAppServicefileEntryId - the primary key of the file entry to check inlockUuid - the lock's UUIDserviceContext - the service context to be applied
PortalException - if the file entry could not be found
SystemException - if a system exception occurredcancelCheckOut(long),
checkOutFileEntry(long, String, long, ServiceContext)
public void checkOutFileEntry(long fileEntryId,
ServiceContext serviceContext)
throws PortalException,
SystemException
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.
checkOutFileEntry in interface DLAppServicefileEntryId - the file entry to check outserviceContext - the service context to be applied
PortalException - if the file entry could not be found
SystemException - if a system exception occurredcancelCheckOut(long),
checkInFileEntry(long, boolean, String, ServiceContext)
public FileEntry checkOutFileEntry(long fileEntryId,
String owner,
long expirationTime,
ServiceContext serviceContext)
throws PortalException,
SystemException
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.
checkOutFileEntry in interface DLAppServicefileEntryId - the file entry to check outowner - the owner string for the checkout (optionally
null)expirationTime - the time in milliseconds before the lock expires.
If the value is 0, the default expiration time will
be used from portal.properties>.serviceContext - the service context to be applied
- Returns:
- the file entry
- Throws:
PortalException - if the file entry could not be found
SystemException - if a system exception occurred- See Also:
cancelCheckOut(long),
checkInFileEntry(long, String)
public Folder copyFolder(long repositoryId,
long sourceFolderId,
long parentFolderId,
String name,
String description,
ServiceContext serviceContext)
throws PortalException,
SystemException
copyFolder in interface DLAppServicerepositoryId - the primary key of the repositorysourceFolderId - the primary key of the folder to copyparentFolderId - the primary key of the new folder's parent foldername - the new folder's namedescription - the new folder's descriptionserviceContext - the service context to be applied
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
public void deleteFileEntry(long fileEntryId)
throws PortalException,
SystemException
deleteFileEntry in interface DLAppServicefileEntryId - the primary key of the file entry
PortalException - if the file entry could not be found
SystemException - if a system exception occurred
public void deleteFileEntryByTitle(long repositoryId,
long folderId,
String title)
throws PortalException,
SystemException
deleteFileEntryByTitle in interface DLAppServicerepositoryId - the primary key of the repositoryfolderId - the primary key of the file entry's parent foldertitle - the file entry's title
PortalException - if the file entry could not be found
SystemException - if a system exception occurred
public void deleteFileShortcut(long fileShortcutId)
throws PortalException,
SystemException
deleteFileShortcut in interface DLAppServicefileShortcutId - the primary key of the file shortcut
PortalException - if the file shortcut could not be found
SystemException - if a system exception occurred
public void deleteFileVersion(long fileEntryId,
String version)
throws PortalException,
SystemException
deleteFileVersion in interface DLAppServicefileEntryId - the primary key of the file entryversion - the version label of the file version
PortalException - if the file version could not be found or invalid
SystemException - if a system exception occurred
public void deleteFolder(long folderId)
throws PortalException,
SystemException
deleteFolder in interface DLAppServicefolderId - the primary key of the folder
PortalException - if the folder could not be found
SystemException - if a system exception occurred
public void deleteFolder(long repositoryId,
long parentFolderId,
String name)
throws PortalException,
SystemException
deleteFolder in interface DLAppServicerepositoryId - the primary key of the repositoryparentFolderId - the primary key of the folder's parent foldername - the folder's name
PortalException - if the folder could not be found
SystemException - if a system exception occurred
public void deleteTempFileEntry(long groupId,
long folderId,
String fileName,
String tempFolderName)
throws PortalException,
SystemException
deleteTempFileEntry in interface DLAppServicegroupId - the primary key of the groupfolderId - the primary key of the folder where the file entry was
eventually to residefileName - the file's original nametempFolderName - the temporary folder's name
PortalException - if the file name was invalid
SystemException - if a system exception occurredTempFileUtil
public List<FileEntry> getFileEntries(long repositoryId,
long folderId)
throws PortalException,
SystemException
getFileEntries in interface DLAppServicerepositoryId - the primary key of the file entry's repositoryfolderId - the primary key of the file entry's folder
PortalException - if the folder could not be found
SystemException - if a system exception occurred
public List<FileEntry> getFileEntries(long repositoryId,
long folderId,
int start,
int end)
throws PortalException,
SystemException
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.
getFileEntries in interface DLAppServicerepositoryId - the primary key of the file entry's repositoryfolderId - the primary key of the file entry's folderstart - the lower bound of the range of resultsend - the upper bound of the range of results (not inclusive)
PortalException - if the folder could not be found
SystemException - if a system exception occurred
public List<FileEntry> getFileEntries(long repositoryId,
long folderId,
int start,
int end,
OrderByComparator obc)
throws PortalException,
SystemException
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.
getFileEntries in interface DLAppServicerepositoryId - the primary key of the file entry's repositoryfolderId - the primary key of the file entry's folderstart - the lower bound of the range of resultsend - the upper bound of the range of results (not inclusive)obc - the comparator to order the file entries (optionally
null)
obc
PortalException - if the folder could not be found
SystemException - if a system exception occurred
public List<FileEntry> getFileEntries(long repositoryId,
long folderId,
long fileEntryTypeId)
throws PortalException,
SystemException
getFileEntries in interface DLAppServicerepositoryId - the primary key of the file entry's repositoryfolderId - the primary key of the file entry's folderfileEntryTypeId - the primary key of the file entry type
PortalException - if the folder could not be found
SystemException - if a system exception occurred
public List<FileEntry> getFileEntries(long repositoryId,
long folderId,
long fileEntryTypeId,
int start,
int end)
throws PortalException,
SystemException
getFileEntries in interface DLAppServicerepositoryId - the primary key of the file entry's repositoryfolderId - the primary key of the file entry's folderfileEntryTypeId - the primary key of the file entry typestart - the lower bound of the range of resultsend - the upper bound of the range of results (not inclusive)
PortalException - if the folder could not be found
SystemException - if a system exception occurred
public List<FileEntry> getFileEntries(long repositoryId,
long folderId,
long fileEntryTypeId,
int start,
int end,
OrderByComparator obc)
throws PortalException,
SystemException
getFileEntries in interface DLAppServicerepositoryId - the primary key of the repositoryfolderId - the primary key of the folderfileEntryTypeId - the primary key of the file entry typestart - the lower bound of the range of resultsend - the upper bound of the range of results (not inclusive)obc - the comparator to order the results by (optionally
null)
null
PortalException - if the folder could not be found
SystemException - if a system exception occurred
public List<Object> getFileEntriesAndFileShortcuts(long repositoryId,
long folderId,
int status,
int start,
int end)
throws PortalException,
SystemException
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.
getFileEntriesAndFileShortcuts in interface DLAppServicerepositoryId - the primary key of the repositoryfolderId - the primary key of the folderstatus - the workflow statusstart - the lower bound of the range of resultsend - the upper bound of the range of results (not inclusive)
PortalException - if the folder could not be found
SystemException - if a system exception occurred
public int getFileEntriesAndFileShortcutsCount(long repositoryId,
long folderId,
int status)
throws PortalException,
SystemException
getFileEntriesAndFileShortcutsCount in interface DLAppServicerepositoryId - the primary key of the repositoryfolderId - the primary key of the folderstatus - the workflow status
PortalException - if the folder ould not be found
SystemException - if a system exception occurred
public int getFileEntriesAndFileShortcutsCount(long repositoryId,
long folderId,
int status,
String[] mimeTypes)
throws PortalException,
SystemException
getFileEntriesAndFileShortcutsCount in interface DLAppServicerepositoryId - the primary key of the repositoryfolderId - the primary key of the folderstatus - the workflow statusmimeTypes - allowed media types
PortalException - if the folder ould not be found
SystemException - if a system exception occurred
public int getFileEntriesCount(long repositoryId,
long folderId)
throws PortalException,
SystemException
getFileEntriesCount in interface DLAppServicerepositoryId - the primary key of the file entry's repositoryfolderId - the primary key of the file entry's folder
PortalException - if the folder could not be found
SystemException - if a system exception occurred
public int getFileEntriesCount(long repositoryId,
long folderId,
long fileEntryTypeId)
throws PortalException,
SystemException
getFileEntriesCount in interface DLAppServicerepositoryId - the primary key of the file entry's repositoryfolderId - the primary key of the file entry's folderfileEntryTypeId - the primary key of the file entry type
PortalException - if the folder could not be found
SystemException - if a system exception occurred
public FileEntry getFileEntry(long fileEntryId)
throws PortalException,
SystemException
getFileEntry in interface DLAppServicefileEntryId - the primary key of the file entry
PortalException - if the file entry could not be found
SystemException - if a system exception occurred
public FileEntry getFileEntry(long groupId,
long folderId,
String title)
throws PortalException,
SystemException
getFileEntry in interface DLAppServicegroupId - the primary key of the file entry's groupfolderId - the primary key of the file entry's foldertitle - the file entry's title
PortalException - if the file entry could not be found
SystemException - if a system exception occurred
public FileEntry getFileEntryByUuidAndGroupId(String uuid,
long groupId)
throws PortalException,
SystemException
getFileEntryByUuidAndGroupId in interface DLAppServiceuuid - the file entry's UUIDgroupId - the primary key of the file entry's group
PortalException - if the file entry could not be found
SystemException - if a system exception occurred
public DLFileShortcut getFileShortcut(long fileShortcutId)
throws PortalException,
SystemException
getFileShortcut in interface DLAppServicefileShortcutId - the primary key of the file shortcut
PortalException - if the file shortcut could not be found
SystemException - if a system exception occurred
public Folder getFolder(long folderId)
throws PortalException,
SystemException
getFolder in interface DLAppServicefolderId - the primary key of the folder
PortalException - if the folder could not be found
SystemException - if a system exception occurred
public Folder getFolder(long repositoryId,
long parentFolderId,
String name)
throws PortalException,
SystemException
getFolder in interface DLAppServicerepositoryId - the primary key of the folder's repositoryparentFolderId - the primary key of the folder's parent foldername - the folder's name
PortalException - if the folder could not be found
SystemException - if a system exception occurred
public List<Folder> getFolders(long repositoryId,
long parentFolderId)
throws PortalException,
SystemException
getFolders in interface DLAppServicerepositoryId - the primary key of the folder's repositoryparentFolderId - the primary key of the folder's parent folder
PortalException - if the parent folder could not be found
SystemException - if a system exception occurred
public List<Folder> getFolders(long repositoryId,
long parentFolderId,
boolean includeMountFolders)
throws PortalException,
SystemException
getFolders in interface DLAppServicerepositoryId - the primary key of the folder's repositoryparentFolderId - the primary key of the folder's parent folderincludeMountFolders - whether to include mount folders for
third-party repositories
PortalException - if the parent folder could not be found
SystemException - if a system exception occurred
public List<Folder> getFolders(long repositoryId,
long parentFolderId,
boolean includeMountFolders,
int start,
int end)
throws PortalException,
SystemException
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.
getFolders in interface DLAppServicerepositoryId - the primary key of the folder's repositoryparentFolderId - the primary key of the folder's parent folderincludeMountFolders - whether to include mount folders for
third-party repositoriesstart - the lower bound of the range of resultsend - the upper bound of the range of results (not inclusive)
PortalException - if the parent folder could not be found
SystemException - if a system exception occurred
public List<Folder> getFolders(long repositoryId,
long parentFolderId,
boolean includeMountFolders,
int start,
int end,
OrderByComparator obc)
throws PortalException,
SystemException
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.
getFolders in interface DLAppServicerepositoryId - the primary key of the folder's repositoryparentFolderId - the primary key of the folder's parent folderincludeMountFolders - whether to include mount folders for
third-party repositoriesstart - the lower bound of the range of resultsend - the upper bound of the range of results (not inclusive)obc - the comparator to order the folders (optionally
null)
obc
PortalException - if the parent folder could not be found
SystemException - if a system exception occurred
public List<Folder> getFolders(long repositoryId,
long parentFolderId,
int status,
boolean includeMountFolders,
int start,
int end,
OrderByComparator obc)
throws PortalException,
SystemException
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.
getFolders in interface DLAppServicerepositoryId - the primary key of the folder's repositoryparentFolderId - the primary key of the folder's parent folderstatus - the workflow statusincludeMountFolders - whether to include mount folders for
third-party repositoriesstart - the lower bound of the range of resultsend - the upper bound of the range of results (not inclusive)obc - the comparator to order the folders (optionally
null)
obc
PortalException - if the parent folder could not be found
SystemException - if a system exception occurred
public List<Folder> getFolders(long repositoryId,
long parentFolderId,
int start,
int end)
throws PortalException,
SystemException
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.
getFolders in interface DLAppServicerepositoryId - the primary key of the folder's repositoryparentFolderId - the primary key of the folder's parent folderstart - the lower bound of the range of resultsend - the upper bound of the range of results (not inclusive)
PortalException - if the parent folder could not be found
SystemException - if a system exception occurred
public List<Folder> getFolders(long repositoryId,
long parentFolderId,
int start,
int end,
OrderByComparator obc)
throws PortalException,
SystemException
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.
getFolders in interface DLAppServicerepositoryId - the primary key of the folder's repositoryparentFolderId - the primary key of the folder's parent folderstart - the lower bound of the range of resultsend - the upper bound of the range of results (not inclusive)obc - the comparator to order the folders (optionally
null)
obc
PortalException - if the parent folder could not be found
SystemException - if a system exception occurred
public List<Object> getFoldersAndFileEntriesAndFileShortcuts(long repositoryId,
long folderId,
int status,
boolean includeMountFolders,
int start,
int end)
throws PortalException,
SystemException
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.
getFoldersAndFileEntriesAndFileShortcuts in interface DLAppServicerepositoryId - the primary key of the repositoryfolderId - the primary key of the parent folderstatus - the workflow statusincludeMountFolders - whether to include mount folders for
third-party repositoriesstart - the lower bound of the range of resultsend - the upper bound of the range of results (not inclusive)
obc
PortalException - if the parent folder could not be found
SystemException - if a system exception occurred
public List<Object> getFoldersAndFileEntriesAndFileShortcuts(long repositoryId,
long folderId,
int status,
boolean includeMountFolders,
int start,
int end,
OrderByComparator obc)
throws PortalException,
SystemException
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.
getFoldersAndFileEntriesAndFileShortcuts in interface DLAppServicerepositoryId - the primary key of the repositoryfolderId - the primary key of the parent folderstatus - the workflow statusincludeMountFolders - whether to include mount folders for
third-party repositoriesstart - the lower bound of the range of resultsend - the upper bound of the range of results (not inclusive)obc - the comparator to order the results (optionally
null)
obc
PortalException - if the parent folder could not be found
SystemException - if a system exception occurred
public List<Object> getFoldersAndFileEntriesAndFileShortcuts(long repositoryId,
long folderId,
int status,
String[] mimeTypes,
boolean includeMountFolders,
int start,
int end,
OrderByComparator obc)
throws PortalException,
SystemException
getFoldersAndFileEntriesAndFileShortcuts in interface DLAppServicePortalException
SystemException
public int getFoldersAndFileEntriesAndFileShortcutsCount(long repositoryId,
long folderId,
int status,
boolean includeMountFolders)
throws PortalException,
SystemException
getFoldersAndFileEntriesAndFileShortcutsCount in interface DLAppServicerepositoryId - the primary key of the repositoryfolderId - the primary key of the parent folderstatus - the workflow statusincludeMountFolders - whether to include mount folders for
third-party repositories
PortalException - if the folder could not be found
SystemException - if a system exception occurred
public int getFoldersAndFileEntriesAndFileShortcutsCount(long repositoryId,
long folderId,
int status,
String[] mimeTypes,
boolean includeMountFolders)
throws PortalException,
SystemException
getFoldersAndFileEntriesAndFileShortcutsCount in interface DLAppServicePortalException
SystemException
public int getFoldersCount(long repositoryId,
long parentFolderId)
throws PortalException,
SystemException
getFoldersCount in interface DLAppServicerepositoryId - the primary key of the folder's repositoryparentFolderId - the primary key of the folder's parent folder
PortalException - if the parent folder could not be found
SystemException - if a system exception occurred
public int getFoldersCount(long repositoryId,
long parentFolderId,
boolean includeMountFolders)
throws PortalException,
SystemException
getFoldersCount in interface DLAppServicerepositoryId - the primary key of the folder's repositoryparentFolderId - the primary key of the folder's parent folderincludeMountFolders - whether to include mount folders for
third-party repositories
PortalException - if the parent folder could not be found
SystemException - if a system exception occurred
public int getFoldersCount(long repositoryId,
long parentFolderId,
int status,
boolean includeMountFolders)
throws PortalException,
SystemException
getFoldersCount in interface DLAppServicerepositoryId - the primary key of the folder's repositoryparentFolderId - the primary key of the folder's parent folderstatus - the workflow statusincludeMountFolders - whether to include mount folders for
third-party repositories
PortalException - if the parent folder could not be found
SystemException - if a system exception occurred
public int getFoldersFileEntriesCount(long repositoryId,
List<Long> folderIds,
int status)
throws PortalException,
SystemException
getFoldersFileEntriesCount in interface DLAppServicerepositoryId - the primary key of the repositoryfolderIds - the primary keys of folders from which to count
immediate subfolders and file entriesstatus - the workflow status
PortalException - if the repository could not be found
SystemException - if a system exception occurred
public List<FileEntry> getGroupFileEntries(long groupId,
long userId,
int start,
int end)
throws PortalException,
SystemException
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.
getGroupFileEntries in interface DLAppServicegroupId - the primary key of the groupuserId - the primary key of the user who created the file
(optionally 0)start - the lower bound of the range of resultsend - the upper bound of the range of results (not inclusive)
PortalException - if the group could not be found
SystemException - if a system exception occurred
public List<FileEntry> getGroupFileEntries(long groupId,
long userId,
int start,
int end,
OrderByComparator obc)
throws PortalException,
SystemException
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.
getGroupFileEntries in interface DLAppServicegroupId - the primary key of the groupuserId - the primary key of the user who created the file
(optionally 0)start - the lower bound of the range of resultsend - the upper bound of the range of results (not inclusive)obc - the comparator to order the file entries (optionally
null)
obc
PortalException - if the group could not be found
SystemException - if a system exception occurred
public List<FileEntry> getGroupFileEntries(long groupId,
long userId,
long rootFolderId,
int start,
int end)
throws PortalException,
SystemException
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.
getGroupFileEntries in interface DLAppServicegroupId - the primary key of the groupuserId - the primary key of the user who created the file
(optionally 0)rootFolderId - the primary key of the root folder to begin the
searchstart - the lower bound of the range of resultsend - the upper bound of the range of results (not inclusive)
PortalException - if the group could not be found
SystemException - if a system exception occurred
public List<FileEntry> getGroupFileEntries(long groupId,
long userId,
long rootFolderId,
int start,
int end,
OrderByComparator obc)
throws PortalException,
SystemException
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.
getGroupFileEntries in interface DLAppServicegroupId - the primary key of the groupuserId - the primary key of the user who created the file
(optionally 0)rootFolderId - the primary key of the root folder to begin the
searchstart - the lower bound of the range of resultsend - the upper bound of the range of results (not inclusive)obc - the comparator to order the file entries (optionally
null)
obc
PortalException - if the group could not be found
SystemException - if a system exception occurred
public List<FileEntry> getGroupFileEntries(long groupId,
long userId,
long rootFolderId,
String[] mimeTypes,
int status,
int start,
int end,
OrderByComparator obc)
throws PortalException,
SystemException
getGroupFileEntries in interface DLAppServicePortalException
SystemException
public int getGroupFileEntriesCount(long groupId,
long userId)
throws PortalException,
SystemException
getGroupFileEntriesCount in interface DLAppServicegroupId - the primary key of the groupuserId - the primary key of the user who created the file
(optionally 0)
PortalException - if the group could not be found
SystemException - if a system exception occurred
public int getGroupFileEntriesCount(long groupId,
long userId,
long rootFolderId)
throws PortalException,
SystemException
getGroupFileEntriesCount in interface DLAppServicegroupId - the primary key of the groupuserId - the primary key of the user who created the file
(optionally 0)rootFolderId - the primary key of the root folder to begin the
search
PortalException - if the group could not be found
SystemException - if a system exception occurred
public int getGroupFileEntriesCount(long groupId,
long userId,
long rootFolderId,
String[] mimeTypes,
int status)
throws PortalException,
SystemException
getGroupFileEntriesCount in interface DLAppServicePortalException
SystemException
public List<Folder> getMountFolders(long repositoryId,
long parentFolderId)
throws PortalException,
SystemException
getMountFolders in interface DLAppServicerepositoryId - the primary key of the folder's repositoryparentFolderId - the primary key of the folder's parent folder
PortalException - if the repository or parent folder could not be
found
SystemException - if a system exception occurred
public List<Folder> getMountFolders(long repositoryId,
long parentFolderId,
int start,
int end)
throws PortalException,
SystemException
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.
getMountFolders in interface DLAppServicerepositoryId - the primary key of the repositoryparentFolderId - the primary key of the parent folderstart - the lower bound of the range of resultsend - the upper bound of the range of results (not inclusive)
PortalException - if the repository or parent folder could not be
found
SystemException - if a system exception occurred
public List<Folder> getMountFolders(long repositoryId,
long parentFolderId,
int start,
int end,
OrderByComparator obc)
throws PortalException,
SystemException
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.
getMountFolders in interface DLAppServicerepositoryId - the primary key of the folder's repositoryparentFolderId - the primary key of the folder's parent folderstart - the lower bound of the range of resultsend - the upper bound of the range of results (not inclusive)obc - the comparator to order the folders (optionally
null)
obc
PortalException - if the repository or parent folder could not be
found
SystemException - if a system exception occurred
public int getMountFoldersCount(long repositoryId,
long parentFolderId)
throws PortalException,
SystemException
getMountFoldersCount in interface DLAppServicerepositoryId - the primary key of the repositoryparentFolderId - the primary key of the parent folder
PortalException - if the repository or parent folder could not be
found
SystemException - if a system exception occurred
public void getSubfolderIds(long repositoryId,
List<Long> folderIds,
long folderId)
throws PortalException,
SystemException
getSubfolderIds in interface DLAppServicePortalException
SystemException
public List<Long> getSubfolderIds(long repositoryId,
long folderId)
throws PortalException,
SystemException
getSubfolderIds in interface DLAppServicerepositoryId - the primary key of the repositoryfolderId - the primary key of the folder
PortalException - if the repository or parent folder could not be
found
SystemException - if a system exception occurred
public List<Long> getSubfolderIds(long repositoryId,
long folderId,
boolean recurse)
throws PortalException,
SystemException
getSubfolderIds in interface DLAppServicerepositoryId - the primary key of the repositoryfolderId - the primary key of the folderrecurse - whether to recurse through each subfolder
PortalException - if the repository or parent folder could not be
found
SystemException - if a system exception occurred
public String[] getTempFileEntryNames(long groupId,
long folderId,
String tempFolderName)
throws PortalException,
SystemException
getTempFileEntryNames in interface DLAppServicegroupId - the primary key of the groupfolderId - the primary key of the folder where the file entry will
eventually residetempFolderName - the temporary folder's name
PortalException - if the folder was invalid
SystemException - if a system exception occurredcom.liferay.portlet.documentlibrary.service.impl.DLAppServiceImpl#addTempFileEntry(
long, long, String, String, File),
TempFileUtil
public Lock lockFileEntry(long fileEntryId)
throws PortalException,
SystemException
checkOutFileEntry(long, ServiceContext)
lockFileEntry in interface DLAppServicePortalException
SystemException
public Lock lockFileEntry(long fileEntryId,
String owner,
long expirationTime)
throws PortalException,
SystemException
checkOutFileEntry(long, String, long,
ServiceContext)
lockFileEntry in interface DLAppServicePortalException
SystemException
public Lock lockFolder(long repositoryId,
long folderId)
throws PortalException,
SystemException
lockFolder in interface DLAppServicerepositoryId - the primary key of the repositoryfolderId - the primary key of the folder
PortalException - if the repository or folder could not be found
SystemException - if a system exception occurred
public Lock lockFolder(long repositoryId,
long folderId,
String owner,
boolean inheritable,
long expirationTime)
throws PortalException,
SystemException
lockFolder in interface DLAppServicerepositoryId - the primary key of the repositoryfolderId - the primary key of the folderowner - the owner string for the checkout (optionally
null)inheritable - whether the lock must propagate to descendantsexpirationTime - 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
public FileEntry moveFileEntry(long fileEntryId,
long newFolderId,
ServiceContext serviceContext)
throws PortalException,
SystemException
moveFileEntry in interface DLAppServicefileEntryId - the primary key of the file entrynewFolderId - the primary key of the new folderserviceContext - the service context to be applied
PortalException - if the file entry or the new folder could not be
found
SystemException - if a system exception occurred
public FileEntry moveFileEntryFromTrash(long fileEntryId,
long newFolderId,
ServiceContext serviceContext)
throws PortalException,
SystemException
moveFileEntryFromTrash in interface DLAppServicefileEntryId - the primary key of the file entrynewFolderId - the primary key of the new folderserviceContext - the service context to be applied
PortalException - if the file entry or the new folder could not be
found
SystemException - if a system exception occurred
public FileEntry moveFileEntryToTrash(long fileEntryId)
throws PortalException,
SystemException
moveFileEntryToTrash in interface DLAppServicefileEntryId - the primary key of the file entry
PortalException - if the file entry could not be found
SystemException - if a system exception occurred
public DLFileShortcut moveFileShortcutFromTrash(long fileShortcutId,
long newFolderId,
ServiceContext serviceContext)
throws PortalException,
SystemException
moveFileShortcutFromTrash in interface DLAppServicefileShortcutId - the primary key of the file shortcutnewFolderId - the primary key of the new folderserviceContext - the service context to be applied
PortalException - if the file entry or the new folder could not be
found
SystemException - if a system exception occurred
public DLFileShortcut moveFileShortcutToTrash(long fileShortcutId)
throws PortalException,
SystemException
moveFileShortcutToTrash in interface DLAppServicefileShortcutId - the primary key of the file shortcut
PortalException - if the file shortcut could not be found
SystemException - if a system exception occurred
public Folder moveFolder(long folderId,
long parentFolderId,
ServiceContext serviceContext)
throws PortalException,
SystemException
moveFolder in interface DLAppServicefolderId - the primary key of the folderparentFolderId - the primary key of the new parent folderserviceContext - the service context to be applied
PortalException - if the folder could not be found
SystemException - if a system exception occurred
public Folder moveFolderFromTrash(long folderId,
long parentFolderId,
ServiceContext serviceContext)
throws PortalException,
SystemException
moveFolderFromTrash in interface DLAppServicefolderId - the primary key of the folderparentFolderId - the primary key of the new parent folderserviceContext - the service context to be applied
PortalException - if the folder could not be found
SystemException - if a system exception occurred
public Folder moveFolderToTrash(long folderId)
throws PortalException,
SystemException
moveFolderToTrash in interface DLAppServicefolderId - the primary key of the folder
PortalException - if the folder could not be found
SystemException - if a system exception occurred
public Lock refreshFileEntryLock(String lockUuid,
long companyId,
long expirationTime)
throws PortalException,
SystemException
refreshFileEntryLock in interface DLAppServicelockUuid - the lock's UUIDcompanyId - the primary key of the file entry's companyexpirationTime - 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
public Lock refreshFolderLock(String lockUuid,
long companyId,
long expirationTime)
throws PortalException,
SystemException
refreshFolderLock in interface DLAppServicelockUuid - the lock's UUIDcompanyId - the primary key of the file entry's companyexpirationTime - 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
public void restoreFileEntryFromTrash(long fileEntryId)
throws PortalException,
SystemException
restoreFileEntryFromTrash in interface DLAppServicefileEntryId - the primary key of the file entry
PortalException - if the file entry could not be found
SystemException - if a system exception occurred
public void restoreFileShortcutFromTrash(long fileShortcutId)
throws PortalException,
SystemException
restoreFileShortcutFromTrash in interface DLAppServicefileShortcutId - the primary key of the file shortcut
PortalException - if the file shortcut could not be found
SystemException - if a system exception occurred
public void restoreFolderFromTrash(long folderId)
throws PortalException,
SystemException
restoreFolderFromTrash in interface DLAppServicefolderId - the primary key of the folder
PortalException - if the folder could not be found
SystemException - if a system exception occurred
public void revertFileEntry(long fileEntryId,
String version,
ServiceContext serviceContext)
throws PortalException,
SystemException
revertFileEntry in interface DLAppServicefileEntryId - the primary key of the file entryversion - the version to revert back toserviceContext - the service context to be applied
PortalException - if the file entry or version could not be found
SystemException - if a system exception occurred
public Hits search(long repositoryId,
SearchContext searchContext)
throws SearchException
search in interface DLAppServiceSearchException
public Hits search(long repositoryId,
SearchContext searchContext,
Query query)
throws SearchException
search in interface DLAppServiceSearchException
public void subscribeFileEntryType(long groupId,
long fileEntryTypeId)
throws PortalException,
SystemException
subscribeFileEntryType in interface DLAppServicegroupId - the primary key of the file entry type's groupfileEntryTypeId - the primary key of the file entry type
PortalException - if the user or group could not be found, or if
subscribing was not permissible
SystemException - if a system exception occurred
public void subscribeFolder(long groupId,
long folderId)
throws PortalException,
SystemException
subscribeFolder in interface DLAppServicegroupId - the primary key of the folder's groupfolderId - the primary key of the folder
PortalException - if the user or group could not be found, or if
subscribing was not permissible
SystemException - if a system exception occurred
public void unlockFileEntry(long fileEntryId)
throws PortalException,
SystemException
checkInFileEntry(long, boolean, String,
ServiceContext).
unlockFileEntry in interface DLAppServicePortalException
SystemException
public void unlockFileEntry(long fileEntryId,
String lockUuid)
throws PortalException,
SystemException
checkInFileEntry(long, String).
unlockFileEntry in interface DLAppServicePortalException
SystemException
public void unlockFolder(long repositoryId,
long folderId,
String lockUuid)
throws PortalException,
SystemException
unlockFolder in interface DLAppServicerepositoryId - the primary key of the repositoryfolderId - the primary key of the folderlockUuid - the lock's UUID
PortalException - if the repository or folder could not be found
SystemException - if a system exception occurred
public void unlockFolder(long repositoryId,
long parentFolderId,
String name,
String lockUuid)
throws PortalException,
SystemException
unlockFolder in interface DLAppServicerepositoryId - the primary key of the repositoryparentFolderId - the primary key of the parent foldername - the folder's namelockUuid - the lock's UUID
PortalException - if the repository or folder could not be found
SystemException - if a system exception occurred
public void unsubscribeFileEntryType(long groupId,
long fileEntryTypeId)
throws PortalException,
SystemException
unsubscribeFileEntryType in interface DLAppServicegroupId - the primary key of the file entry type's groupfileEntryTypeId - the primary key of the file entry type
PortalException - if the user or group could not be found, or if
unsubscribing was not permissible
SystemException - if a system exception occurred
public void unsubscribeFolder(long groupId,
long folderId)
throws PortalException,
SystemException
unsubscribeFolder in interface DLAppServicegroupId - the primary key of the folder's groupfolderId - the primary key of the folder
PortalException - if the user or group could not be found, or if
unsubscribing was not permissible
SystemException - if a system exception occurred
public FileEntry updateFileEntry(long fileEntryId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
boolean majorVersion,
byte[] bytes,
ServiceContext serviceContext)
throws PortalException,
SystemException
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.
updateFileEntry in interface DLAppServicefileEntryId - the primary key of the file entrysourceFileName - the original file's name (optionally
null)mimeType - the file's MIME type (optionally null)title - the new name to be assigned to the file (optionally
null)description - the file's new descriptionchangeLog - the file's version change log (optionally
null)majorVersion - whether the new file version is a major versionbytes - the file's data (optionally null)serviceContext - the service context to be applied. Can set the
asset category IDs, asset tag names, and expando bridge
attributes for the file entry. In a Liferay repository, it may
include: PortalException - if the file entry could not be found
SystemException - if a system exception occurred
public FileEntry updateFileEntry(long fileEntryId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
boolean majorVersion,
File file,
ServiceContext serviceContext)
throws PortalException,
SystemException
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.
updateFileEntry in interface DLAppServicefileEntryId - the primary key of the file entrysourceFileName - the original file's name (optionally
null)mimeType - the file's MIME type (optionally null)title - the new name to be assigned to the file (optionally
null)description - the file's new descriptionchangeLog - the file's version change log (optionally
null)majorVersion - whether the new file version is a major versionfile - EntryId the primary key of the file entryserviceContext - the service context to be applied. Can set the
asset category IDs, asset tag names, and expando bridge
attributes for the file entry. In a Liferay repository, it may
include: PortalException - if the file entry could not be found
SystemException - if a system exception occurred
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
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.
updateFileEntry in interface DLAppServicefileEntryId - the primary key of the file entrysourceFileName - the original file's name (optionally
null)mimeType - the file's MIME type (optionally null)title - the new name to be assigned to the file (optionally
null)description - the file's new descriptionchangeLog - the file's version change log (optionally
null)majorVersion - whether the new file version is a major versionis - 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: PortalException - if the file entry could not be found
SystemException - if a system exception occurred
public FileEntry updateFileEntryAndCheckIn(long fileEntryId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
boolean majorVersion,
File file,
ServiceContext serviceContext)
throws PortalException,
SystemException
updateFileEntryAndCheckIn in interface DLAppServicePortalException
SystemException
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
updateFileEntryAndCheckIn in interface DLAppServicePortalException
SystemException
public DLFileShortcut updateFileShortcut(long fileShortcutId,
long folderId,
long toFileEntryId,
ServiceContext serviceContext)
throws PortalException,
SystemException
updateFileShortcut in interface DLAppServicefileShortcutId - the primary key of the file shortcutfolderId - the primary key of the file shortcut's parent foldertoFileEntryId - the primary key of the file shortcut's file entryserviceContext - the service context to be applied. Can set the
asset category IDs, asset tag names, and expando bridge
attributes for the file entry.
PortalException - if the file shortcut, folder, or file entry could
not be found
SystemException - if a system exception occurred
public Folder updateFolder(long folderId,
String name,
String description,
ServiceContext serviceContext)
throws PortalException,
SystemException
updateFolder in interface DLAppServicefolderId - the primary key of the foldername - the folder's new namedescription - the folder's new descriptionserviceContext - the service context to be applied. In a Liferay
repository, it may include: workflowDefinition appended by the
fileEntryTypeId (optionally 0). 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
public boolean verifyFileEntryCheckOut(long repositoryId,
long fileEntryId,
String lockUuid)
throws PortalException,
SystemException
true if the file entry is checked out. This method
is primarily used by WebDAV.
verifyFileEntryCheckOut in interface DLAppServicerepositoryId - the primary key for the repositoryfileEntryId - the primary key for the file entrylockUuid - the lock's UUID
true if the file entry is checked out;
false otherwise
PortalException - if the file entry could not be found
SystemException - if a system exception occurred
public boolean verifyFileEntryLock(long repositoryId,
long fileEntryId,
String lockUuid)
throws PortalException,
SystemException
verifyFileEntryLock in interface DLAppServicePortalException
SystemException
public boolean verifyInheritableLock(long repositoryId,
long folderId,
String lockUuid)
throws PortalException,
SystemException
true if the inheritable lock exists. This method is
primarily used by WebDAV.
verifyInheritableLock in interface DLAppServicerepositoryId - the primary key for the repositoryfolderId - the primary key for the folderlockUuid - the lock's UUID
true if the inheritable lock exists;
false otherwise
PortalException - if the folder could not be found
SystemException - if a system exception occurredpublic DLAppService getWrappedDLAppService()
getWrappedService()
public void setWrappedDLAppService(DLAppService dlAppService)
setWrappedService(com.liferay.portlet.documentlibrary.service.DLAppService)
public DLAppService getWrappedService()
getWrappedService in interface ServiceWrapper<DLAppService>public void setWrappedService(DLAppService dlAppService)
setWrappedService in interface ServiceWrapper<DLAppService>
|
Liferay 6.2.0-ce-m4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||