public class DLAppLocalServiceImpl extends DLAppLocalServiceBaseImpl
This class provides a unified interface to all Liferay and third party repositories. While the method signatures are universal for all repositories. Additional implementation-specific parameters may be specified in the serviceContext.
The repositoryId parameter used by most of the methods is the
primary key of the specific repository. If the repository is a default
Liferay repository, the repositoryId is the groupId
or scopeGroupId. Otherwise, the repositoryId will
correspond to values obtained from RepositoryLocalServiceUtil.
DLAppServiceImplcounterLocalService, dlAppHelperLocalService, dlAppLocalService, dlAppService, dlContentLocalService, dlContentPersistence, dlFileEntryFinder, dlFileEntryLocalService, dlFileEntryMetadataLocalService, dlFileEntryMetadataPersistence, dlFileEntryPersistence, dlFileEntryService, dlFileEntryTypeFinder, dlFileEntryTypeLocalService, dlFileEntryTypePersistence, dlFileEntryTypeService, dlFileRankFinder, dlFileRankLocalService, dlFileRankPersistence, dlFileShortcutLocalService, dlFileShortcutPersistence, dlFileShortcutService, dlFileVersionLocalService, dlFileVersionPersistence, dlFileVersionService, dlFolderFinder, dlFolderLocalService, dlFolderPersistence, dlFolderService, dlSyncEventLocalService, dlSyncEventPersistence, lockFinder, lockLocalService, lockPersistence, repositoryEntryLocalService, repositoryEntryPersistence, repositoryLocalService, repositoryPersistence, repositoryService, resourceLocalService, subscriptionLocalService, subscriptionPersistence, userFinder, userLocalService, userPersistence, userService| Constructor and Description |
|---|
DLAppLocalServiceImpl() |
| Modifier and Type | Method and Description |
|---|---|
com.liferay.portal.kernel.repository.model.FileEntry |
addFileEntry(long userId,
long repositoryId,
long folderId,
java.lang.String sourceFileName,
java.lang.String mimeType,
java.lang.String title,
java.lang.String description,
java.lang.String changeLog,
byte[] bytes,
com.liferay.portal.service.ServiceContext serviceContext)
Adds a file entry and associated metadata based on a byte array.
|
com.liferay.portal.kernel.repository.model.FileEntry |
addFileEntry(long userId,
long repositoryId,
long folderId,
java.lang.String sourceFileName,
java.lang.String mimeType,
java.lang.String title,
java.lang.String description,
java.lang.String changeLog,
java.io.File file,
com.liferay.portal.service.ServiceContext serviceContext)
Adds a file entry and associated metadata based on a
File
object. |
com.liferay.portal.kernel.repository.model.FileEntry |
addFileEntry(long userId,
long repositoryId,
long folderId,
java.lang.String sourceFileName,
java.lang.String mimeType,
java.lang.String title,
java.lang.String description,
java.lang.String changeLog,
java.io.InputStream is,
long size,
com.liferay.portal.service.ServiceContext serviceContext)
Adds a file entry and associated metadata based on an
InputStream
object. |
com.liferay.portlet.documentlibrary.model.DLFileRank |
addFileRank(long repositoryId,
long companyId,
long userId,
long fileEntryId,
com.liferay.portal.service.ServiceContext serviceContext)
Adds the file rank to the existing file entry.
|
com.liferay.portlet.documentlibrary.model.DLFileShortcut |
addFileShortcut(long userId,
long repositoryId,
long folderId,
long toFileEntryId,
com.liferay.portal.service.ServiceContext serviceContext)
Adds the file shortcut to the existing file entry.
|
com.liferay.portal.kernel.repository.model.Folder |
addFolder(long userId,
long repositoryId,
long parentFolderId,
java.lang.String name,
java.lang.String description,
com.liferay.portal.service.ServiceContext serviceContext)
Adds a folder.
|
protected com.liferay.portal.kernel.repository.model.FileEntry |
copyFileEntry(long userId,
com.liferay.portal.kernel.repository.LocalRepository toLocalRepository,
com.liferay.portal.kernel.repository.model.FileEntry fileEntry,
long newFolderId,
com.liferay.portal.service.ServiceContext serviceContext) |
void |
deleteAll(long repositoryId)
Delete all data associated to the given repository.
|
void |
deleteFileEntry(long fileEntryId)
Deletes the file entry.
|
protected void |
deleteFileEntry(long oldFileEntryId,
long newFileEntryId,
com.liferay.portal.kernel.repository.LocalRepository fromLocalRepository,
com.liferay.portal.kernel.repository.LocalRepository toLocalRepository) |
void |
deleteFileRanksByFileEntryId(long fileEntryId)
Deletes the file ranks associated to a given file entry.
|
void |
deleteFileRanksByUserId(long userId)
Deletes the file ranks associated to a given user.
|
void |
deleteFileShortcut(com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut)
Deletes the file shortcut.
|
void |
deleteFileShortcut(long fileShortcutId)
Deletes the file shortcut.
|
void |
deleteFileShortcuts(long toFileEntryId)
Deletes all file shortcuts associated to the file entry.
|
void |
deleteFolder(long folderId)
Deletes the folder and all of its subfolders and file entries.
|
com.liferay.portal.kernel.repository.model.FileEntry |
getFileEntry(long fileEntryId)
Returns the file entry with the primary key.
|
com.liferay.portal.kernel.repository.model.FileEntry |
getFileEntry(long groupId,
long folderId,
java.lang.String title)
Returns the file entry with the title in the folder.
|
com.liferay.portal.kernel.repository.model.FileEntry |
getFileEntryByUuidAndGroupId(java.lang.String uuid,
long groupId)
Returns the file entry with the UUID and group.
|
protected com.liferay.portal.kernel.repository.LocalRepository |
getFileEntryLocalRepository(long fileEntryId) |
java.util.List<com.liferay.portlet.documentlibrary.model.DLFileRank> |
getFileRanks(long repositoryId,
long userId)
Returns the file ranks from the user.
|
com.liferay.portlet.documentlibrary.model.DLFileShortcut |
getFileShortcut(long fileShortcutId)
Returns the file shortcut with the primary key.
|
com.liferay.portal.kernel.repository.model.FileVersion |
getFileVersion(long fileVersionId)
Returns the file version with the primary key.
|
protected com.liferay.portal.kernel.repository.LocalRepository |
getFileVersionLocalRepository(long fileVersionId) |
com.liferay.portal.kernel.repository.model.Folder |
getFolder(long folderId)
Returns the folder with the primary key.
|
com.liferay.portal.kernel.repository.model.Folder |
getFolder(long repositoryId,
long parentFolderId,
java.lang.String name)
Returns the folder with the name in the parent folder.
|
protected com.liferay.portal.kernel.repository.LocalRepository |
getFolderLocalRepository(long folderId) |
protected com.liferay.portal.kernel.repository.LocalRepository |
getFolderLocalRepository(long folderId,
long groupId) |
protected com.liferay.portal.kernel.repository.LocalRepository |
getLocalRepository(long repositoryId) |
com.liferay.portal.kernel.repository.model.Folder |
getMountFolder(long repositoryId)
Returns the mount folder of the repository with the primary key.
|
protected com.liferay.portal.kernel.repository.model.FileEntry |
moveFileEntries(long userId,
long fileEntryId,
long newFolderId,
com.liferay.portal.kernel.repository.LocalRepository fromLocalRepository,
com.liferay.portal.kernel.repository.LocalRepository toLocalRepository,
com.liferay.portal.service.ServiceContext serviceContext) |
com.liferay.portal.kernel.repository.model.FileEntry |
moveFileEntry(long userId,
long fileEntryId,
long newFolderId,
com.liferay.portal.service.ServiceContext serviceContext)
Moves the file entry to the new folder.
|
com.liferay.portal.kernel.repository.model.FileEntry |
moveFileEntryToTrash(long userId,
long fileEntryId)
Moves the file entry with the primary key to the trash portlet.
|
com.liferay.portal.kernel.repository.model.Folder |
moveFolder(long userId,
long folderId,
long parentFolderId,
com.liferay.portal.service.ServiceContext serviceContext) |
protected com.liferay.portal.kernel.repository.model.Folder |
moveFolders(long userId,
long folderId,
long parentFolderId,
com.liferay.portal.kernel.repository.LocalRepository sourceLocalRepository,
com.liferay.portal.kernel.repository.LocalRepository destinationLocalRepository,
com.liferay.portal.service.ServiceContext serviceContext) |
void |
restoreFileEntryFromTrash(long userId,
long fileEntryId)
Restores the file entry with the primary key from the trash portlet.
|
void |
subscribeFileEntryType(long userId,
long groupId,
long fileEntryTypeId)
Subscribe the user to changes in documents of the file entry type.
|
void |
subscribeFolder(long userId,
long groupId,
long folderId)
Subscribe the user to document changes in the folder.
|
void |
unsubscribeFileEntryType(long userId,
long groupId,
long fileEntryTypeId)
Unsubscribe the user from changes in documents of the file entry type.
|
void |
unsubscribeFolder(long userId,
long groupId,
long folderId)
Unsubscribe the user from document changes in the folder.
|
void |
updateAsset(long userId,
com.liferay.portal.kernel.repository.model.FileEntry fileEntry,
com.liferay.portal.kernel.repository.model.FileVersion fileVersion,
long[] assetCategoryIds,
java.lang.String[] assetTagNames,
long[] assetLinkEntryIds)
Updates the file entry's asset replacing its asset categories, tags, and
links.
|
com.liferay.portal.kernel.repository.model.FileEntry |
updateFileEntry(long userId,
long fileEntryId,
java.lang.String sourceFileName,
java.lang.String mimeType,
java.lang.String title,
java.lang.String description,
java.lang.String changeLog,
boolean majorVersion,
byte[] bytes,
com.liferay.portal.service.ServiceContext serviceContext)
Updates a file entry and associated metadata based on a byte array
object.
|
com.liferay.portal.kernel.repository.model.FileEntry |
updateFileEntry(long userId,
long fileEntryId,
java.lang.String sourceFileName,
java.lang.String mimeType,
java.lang.String title,
java.lang.String description,
java.lang.String changeLog,
boolean majorVersion,
java.io.File file,
com.liferay.portal.service.ServiceContext serviceContext)
Updates a file entry and associated metadata based on a
File object. |
com.liferay.portal.kernel.repository.model.FileEntry |
updateFileEntry(long userId,
long fileEntryId,
java.lang.String sourceFileName,
java.lang.String mimeType,
java.lang.String title,
java.lang.String description,
java.lang.String changeLog,
boolean majorVersion,
java.io.InputStream is,
long size,
com.liferay.portal.service.ServiceContext serviceContext)
Updates a file entry and associated metadata based on an
InputStream object. |
com.liferay.portlet.documentlibrary.model.DLFileRank |
updateFileRank(long repositoryId,
long companyId,
long userId,
long fileEntryId,
com.liferay.portal.service.ServiceContext serviceContext)
Updates a file rank to the existing file entry.
|
com.liferay.portlet.documentlibrary.model.DLFileShortcut |
updateFileShortcut(long userId,
long fileShortcutId,
long folderId,
long toFileEntryId,
com.liferay.portal.service.ServiceContext serviceContext)
Updates a file shortcut to the existing file entry.
|
void |
updateFileShortcuts(long toRepositoryId,
long oldToFileEntryId,
long newToFileEntryId)
Updates all file shortcuts to the existing file entry to the new file
entry.
|
com.liferay.portal.kernel.repository.model.Folder |
updateFolder(long folderId,
long parentFolderId,
java.lang.String name,
java.lang.String description,
com.liferay.portal.service.ServiceContext serviceContext)
Updates the folder.
|
afterPropertiesSet, destroy, getBeanIdentifier, getCounterLocalService, getDLAppHelperLocalService, getDLAppLocalService, getDLAppService, getDLContentLocalService, getDLContentPersistence, getDLFileEntryFinder, getDLFileEntryLocalService, getDLFileEntryMetadataLocalService, getDLFileEntryMetadataPersistence, getDLFileEntryPersistence, getDLFileEntryService, getDLFileEntryTypeFinder, getDLFileEntryTypeLocalService, getDLFileEntryTypePersistence, getDLFileEntryTypeService, getDLFileRankFinder, getDLFileRankLocalService, getDLFileRankPersistence, getDLFileShortcutLocalService, getDLFileShortcutPersistence, getDLFileShortcutService, getDLFileVersionLocalService, getDLFileVersionPersistence, getDLFileVersionService, getDLFolderFinder, getDLFolderLocalService, getDLFolderPersistence, getDLFolderService, getDLSyncEventLocalService, getDLSyncEventPersistence, getLockFinder, getLockLocalService, getLockPersistence, getRepositoryEntryLocalService, getRepositoryEntryPersistence, getRepositoryLocalService, getRepositoryPersistence, getRepositoryService, getResourceLocalService, getSubscriptionLocalService, getSubscriptionPersistence, getUserFinder, getUserLocalService, getUserPersistence, getUserService, runSQL, setBeanIdentifier, setCounterLocalService, setDLAppHelperLocalService, setDLAppLocalService, setDLAppService, setDLContentLocalService, setDLContentPersistence, setDLFileEntryFinder, setDLFileEntryLocalService, setDLFileEntryMetadataLocalService, setDLFileEntryMetadataPersistence, setDLFileEntryPersistence, setDLFileEntryService, setDLFileEntryTypeFinder, setDLFileEntryTypeLocalService, setDLFileEntryTypePersistence, setDLFileEntryTypeService, setDLFileRankFinder, setDLFileRankLocalService, setDLFileRankPersistence, setDLFileShortcutLocalService, setDLFileShortcutPersistence, setDLFileShortcutService, setDLFileVersionLocalService, setDLFileVersionPersistence, setDLFileVersionService, setDLFolderFinder, setDLFolderLocalService, setDLFolderPersistence, setDLFolderService, setDLSyncEventLocalService, setDLSyncEventPersistence, setLockFinder, setLockLocalService, setLockPersistence, setRepositoryEntryLocalService, setRepositoryEntryPersistence, setRepositoryLocalService, setRepositoryPersistence, setRepositoryService, setResourceLocalService, setSubscriptionLocalService, setSubscriptionPersistence, setUserFinder, setUserLocalService, setUserPersistence, setUserServicepublic com.liferay.portal.kernel.repository.model.FileEntry addFileEntry(long userId,
long repositoryId,
long folderId,
java.lang.String sourceFileName,
java.lang.String mimeType,
java.lang.String title,
java.lang.String description,
java.lang.String changeLog,
byte[] bytes,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.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.
userId - the primary key of the file entry's creator/ownerrepositoryId - the primary key of the file entry's 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: com.liferay.portal.kernel.exception.PortalException - if the parent folder could not be found or if the
file entry's information was invalidcom.liferay.portal.kernel.exception.SystemException - if a system exception occurredpublic com.liferay.portal.kernel.repository.model.FileEntry addFileEntry(long userId,
long repositoryId,
long folderId,
java.lang.String sourceFileName,
java.lang.String mimeType,
java.lang.String title,
java.lang.String description,
java.lang.String changeLog,
java.io.File file,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.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.
userId - the primary key of the file entry's creator/ownerrepositoryId - 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: com.liferay.portal.kernel.exception.PortalException - if the parent folder could not be found or if the
file entry's information was invalidcom.liferay.portal.kernel.exception.SystemException - if a system exception occurredpublic com.liferay.portal.kernel.repository.model.FileEntry addFileEntry(long userId,
long repositoryId,
long folderId,
java.lang.String sourceFileName,
java.lang.String mimeType,
java.lang.String title,
java.lang.String description,
java.lang.String changeLog,
java.io.InputStream is,
long size,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.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.
userId - the primary key of the file entry's creator/ownerrepositoryId - 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: com.liferay.portal.kernel.exception.PortalException - if the parent folder could not be found or if the
file entry's information was invalidcom.liferay.portal.kernel.exception.SystemException - if a system exception occurredpublic com.liferay.portlet.documentlibrary.model.DLFileRank addFileRank(long repositoryId,
long companyId,
long userId,
long fileEntryId,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.SystemException
repositoryId - the primary key of the repositorycompanyId - the primary key of the companyuserId - the primary key of the file rank's creator/ownerfileEntryId - the primary key of the file entryserviceContext - the service context to be appliedcom.liferay.portal.kernel.exception.SystemException - if a system exception occurredpublic com.liferay.portlet.documentlibrary.model.DLFileShortcut addFileShortcut(long userId,
long repositoryId,
long folderId,
long toFileEntryId,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
userId - the primary key of the file shortcut's creator/ownerrepositoryId - the primary key of the repositoryfolderId - the primary key of the file shortcut's parent foldertoFileEntryId - the primary key of the file entry to point toserviceContext - the service context to be applied. Can set the
asset category IDs, asset tag names, and expando bridge
attributes for the file entry.com.liferay.portal.kernel.exception.PortalException - if the parent folder or file entry could not be
found, or if the file shortcut's information was invalidcom.liferay.portal.kernel.exception.SystemException - if a system exception occurredpublic com.liferay.portal.kernel.repository.model.Folder addFolder(long userId,
long repositoryId,
long parentFolderId,
java.lang.String name,
java.lang.String description,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
userId - the primary key of the folder's creator/ownerrepositoryId - 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 mountPoint which is a boolean
specifying whether the folder is a facade for mounting a
third-party repositorycom.liferay.portal.kernel.exception.PortalException - if the parent folder could not be found or if the
new folder's information was invalidcom.liferay.portal.kernel.exception.SystemException - if a system exception occurredpublic void deleteAll(long repositoryId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
repositoryId - the primary key of the data's repositorycom.liferay.portal.kernel.exception.PortalException - if the repository could not be foundcom.liferay.portal.kernel.exception.SystemException - if a system exception occurredpublic void deleteFileEntry(long fileEntryId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
fileEntryId - the primary key of the file entrycom.liferay.portal.kernel.exception.PortalException - if the file entry could not be foundcom.liferay.portal.kernel.exception.SystemException - if a system exception occurredpublic void deleteFileRanksByFileEntryId(long fileEntryId)
throws com.liferay.portal.kernel.exception.SystemException
fileEntryId - the primary key of the file entrycom.liferay.portal.kernel.exception.SystemException - if a system exception occurredpublic void deleteFileRanksByUserId(long userId)
throws com.liferay.portal.kernel.exception.SystemException
userId - the primary key of the usercom.liferay.portal.kernel.exception.SystemException - if a system exception occurredpublic void deleteFileShortcut(com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
dlFileShortcut - the file shortcutcom.liferay.portal.kernel.exception.PortalException - if the file shortcut could not be foundcom.liferay.portal.kernel.exception.SystemException - if a system exception occurredpublic void deleteFileShortcut(long fileShortcutId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
fileShortcutId - the primary key of the file shortcutcom.liferay.portal.kernel.exception.PortalException - if the file shortcut could not be foundcom.liferay.portal.kernel.exception.SystemException - if a system exception occurredpublic void deleteFileShortcuts(long toFileEntryId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
toFileEntryId - the primary key of the associated file entrycom.liferay.portal.kernel.exception.PortalException - if the file shortcut for the file entry could not
be foundcom.liferay.portal.kernel.exception.SystemException - if a system exception occurredpublic void deleteFolder(long folderId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
folderId - the primary key of the foldercom.liferay.portal.kernel.exception.PortalException - if the folder could not be foundcom.liferay.portal.kernel.exception.SystemException - if a system exception occurredpublic com.liferay.portal.kernel.repository.model.FileEntry getFileEntry(long fileEntryId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
fileEntryId - the primary key of the file entrycom.liferay.portal.kernel.exception.PortalException - if the file entry could not be foundcom.liferay.portal.kernel.exception.SystemException - if a system exception occurredpublic com.liferay.portal.kernel.repository.model.FileEntry getFileEntry(long groupId,
long folderId,
java.lang.String title)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
groupId - the primary key of the file entry's groupfolderId - the primary key of the file entry's foldertitle - the file entry's titlecom.liferay.portal.kernel.exception.PortalException - if the file entry could not be foundcom.liferay.portal.kernel.exception.SystemException - if a system exception occurredpublic com.liferay.portal.kernel.repository.model.FileEntry getFileEntryByUuidAndGroupId(java.lang.String uuid,
long groupId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
uuid - the file entry's UUIDgroupId - the primary key of the file entry's groupcom.liferay.portal.kernel.exception.PortalException - if the file entry could not be foundcom.liferay.portal.kernel.exception.SystemException - if a system exception occurredpublic java.util.List<com.liferay.portlet.documentlibrary.model.DLFileRank> getFileRanks(long repositoryId,
long userId)
throws com.liferay.portal.kernel.exception.SystemException
repositoryId - the primary key of the repositoryuserId - the primary key of the usercom.liferay.portal.kernel.exception.SystemException - if a system exception occurredpublic com.liferay.portlet.documentlibrary.model.DLFileShortcut getFileShortcut(long fileShortcutId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
fileShortcutId - the primary key of the file shortcutcom.liferay.portal.kernel.exception.PortalException - if the file shortcut could not be foundcom.liferay.portal.kernel.exception.SystemException - if a system exception occurredpublic com.liferay.portal.kernel.repository.model.FileVersion getFileVersion(long fileVersionId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
fileVersionId - the primary key of the file versioncom.liferay.portal.kernel.exception.PortalException - if the file version could not be foundcom.liferay.portal.kernel.exception.SystemException - if a system exception occurredpublic com.liferay.portal.kernel.repository.model.Folder getFolder(long folderId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
folderId - the primary key of the foldercom.liferay.portal.kernel.exception.PortalException - if the folder could not be foundcom.liferay.portal.kernel.exception.SystemException - if a system exception occurredpublic com.liferay.portal.kernel.repository.model.Folder getFolder(long repositoryId,
long parentFolderId,
java.lang.String name)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
repositoryId - the primary key of the folder's repositoryparentFolderId - the primary key of the folder's parent foldername - the folder's namecom.liferay.portal.kernel.exception.PortalException - if the folder could not be foundcom.liferay.portal.kernel.exception.SystemException - if a system exception occurredpublic com.liferay.portal.kernel.repository.model.Folder getMountFolder(long repositoryId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
repositoryId - the primary key of the repositorycom.liferay.portal.kernel.exception.PortalException - if the repository or mount folder could not be
foundcom.liferay.portal.kernel.exception.SystemException - if a system exception occurredpublic com.liferay.portal.kernel.repository.model.FileEntry moveFileEntry(long userId,
long fileEntryId,
long newFolderId,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
userId - the primary key of the userfileEntryId - the primary key of the file entrynewFolderId - the primary key of the new folderserviceContext - the service context to be appliedcom.liferay.portal.kernel.exception.PortalException - if the file entry or the new folder could not be
foundcom.liferay.portal.kernel.exception.SystemException - if a system exception occurredpublic com.liferay.portal.kernel.repository.model.FileEntry moveFileEntryToTrash(long userId,
long fileEntryId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
userId - the primary key of the userfileEntryId - the primary key of the file entrycom.liferay.portal.kernel.exception.PortalException - if the file entry could not be foundcom.liferay.portal.kernel.exception.SystemException - if a system exception occurredpublic com.liferay.portal.kernel.repository.model.Folder moveFolder(long userId,
long folderId,
long parentFolderId,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
com.liferay.portal.kernel.exception.PortalExceptioncom.liferay.portal.kernel.exception.SystemExceptionpublic void restoreFileEntryFromTrash(long userId,
long fileEntryId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
userId - the primary key of the userfileEntryId - the primary key of the file entrycom.liferay.portal.kernel.exception.PortalException - if the file entry could not be foundcom.liferay.portal.kernel.exception.SystemException - if a system exception occurredpublic void subscribeFileEntryType(long userId,
long groupId,
long fileEntryTypeId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
userId - the primary key of the usergroupId - the primary key of the file entry type's groupfileEntryTypeId - the primary key of the file entry typecom.liferay.portal.kernel.exception.PortalException - if the user or group could not be foundcom.liferay.portal.kernel.exception.SystemException - if a system exception occurredpublic void subscribeFolder(long userId,
long groupId,
long folderId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
userId - the primary key of the usergroupId - the primary key of the folder's groupfolderId - the primary key of the foldercom.liferay.portal.kernel.exception.PortalException - if the user or group could not be foundcom.liferay.portal.kernel.exception.SystemException - if a system exception occurredpublic void unsubscribeFileEntryType(long userId,
long groupId,
long fileEntryTypeId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
userId - the primary key of the usergroupId - the primary key of the file entry type's groupfileEntryTypeId - the primary key of the file entry typecom.liferay.portal.kernel.exception.PortalException - if the user or group could not be foundcom.liferay.portal.kernel.exception.SystemException - if a system exception occurredpublic void unsubscribeFolder(long userId,
long groupId,
long folderId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
userId - the primary key of the usergroupId - the primary key of the folder's groupfolderId - the primary key of the foldercom.liferay.portal.kernel.exception.PortalException - if the user or group could not be foundcom.liferay.portal.kernel.exception.SystemException - if a system exception occurredpublic void updateAsset(long userId,
com.liferay.portal.kernel.repository.model.FileEntry fileEntry,
com.liferay.portal.kernel.repository.model.FileVersion fileVersion,
long[] assetCategoryIds,
java.lang.String[] assetTagNames,
long[] assetLinkEntryIds)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
userId - the primary key of the userfileEntry - the file entry to updatefileVersion - the file version to updateassetCategoryIds - the primary keys of the new asset categoriesassetTagNames - the new asset tag namesassetLinkEntryIds - the primary keys of the new asset link entriescom.liferay.portal.kernel.exception.PortalException - if the file entry or version could not be foundcom.liferay.portal.kernel.exception.SystemException - if a system exception occurredpublic com.liferay.portal.kernel.repository.model.FileEntry updateFileEntry(long userId,
long fileEntryId,
java.lang.String sourceFileName,
java.lang.String mimeType,
java.lang.String title,
java.lang.String description,
java.lang.String changeLog,
boolean majorVersion,
byte[] bytes,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.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.
userId - the primary key of the userfileEntryId - 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: com.liferay.portal.kernel.exception.PortalException - if the file entry could not be foundcom.liferay.portal.kernel.exception.SystemException - if a system exception occurredpublic com.liferay.portal.kernel.repository.model.FileEntry updateFileEntry(long userId,
long fileEntryId,
java.lang.String sourceFileName,
java.lang.String mimeType,
java.lang.String title,
java.lang.String description,
java.lang.String changeLog,
boolean majorVersion,
java.io.File file,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.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.
userId - the primary key of the userfileEntryId - 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 - 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: com.liferay.portal.kernel.exception.PortalException - if the file entry could not be foundcom.liferay.portal.kernel.exception.SystemException - if a system exception occurredpublic com.liferay.portal.kernel.repository.model.FileEntry updateFileEntry(long userId,
long fileEntryId,
java.lang.String sourceFileName,
java.lang.String mimeType,
java.lang.String title,
java.lang.String description,
java.lang.String changeLog,
boolean majorVersion,
java.io.InputStream is,
long size,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.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.
userId - the primary key of the userfileEntryId - 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: com.liferay.portal.kernel.exception.PortalException - if the file entry could not be foundcom.liferay.portal.kernel.exception.SystemException - if a system exception occurredpublic com.liferay.portlet.documentlibrary.model.DLFileRank updateFileRank(long repositoryId,
long companyId,
long userId,
long fileEntryId,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.SystemException
repositoryId - the primary key of the file rank's repositorycompanyId - the primary key of the file rank's companyuserId - the primary key of the file rank's creator/ownerfileEntryId - the primary key of the file rank's file entryserviceContext - the service context to be appliedcom.liferay.portal.kernel.exception.SystemException - if a system exception occurredpublic com.liferay.portlet.documentlibrary.model.DLFileShortcut updateFileShortcut(long userId,
long fileShortcutId,
long folderId,
long toFileEntryId,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
userId - the primary key of the file shortcut's creator/ownerfileShortcutId - 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.com.liferay.portal.kernel.exception.PortalException - if the file shortcut, folder, or file entry could
not be foundcom.liferay.portal.kernel.exception.SystemException - if a system exception occurredpublic void updateFileShortcuts(long toRepositoryId,
long oldToFileEntryId,
long newToFileEntryId)
throws com.liferay.portal.kernel.exception.SystemException
toRepositoryId - the primary key of the repositoryoldToFileEntryId - the primary key of the old file entry pointed tonewToFileEntryId - the primary key of the new file entry to point
tocom.liferay.portal.kernel.exception.SystemException - if a system exception occurredpublic com.liferay.portal.kernel.repository.model.Folder updateFolder(long folderId,
long parentFolderId,
java.lang.String name,
java.lang.String description,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
folderId - the primary key of the folderparentFolderId - the primary key of the folder's new parent 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). com.liferay.portal.kernel.exception.PortalException - if the current or new parent folder could not be
found, or if the new parent folder's information was invalidcom.liferay.portal.kernel.exception.SystemException - if a system exception occurredprotected com.liferay.portal.kernel.repository.model.FileEntry copyFileEntry(long userId,
com.liferay.portal.kernel.repository.LocalRepository toLocalRepository,
com.liferay.portal.kernel.repository.model.FileEntry fileEntry,
long newFolderId,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
com.liferay.portal.kernel.exception.PortalExceptioncom.liferay.portal.kernel.exception.SystemExceptionprotected void deleteFileEntry(long oldFileEntryId,
long newFileEntryId,
com.liferay.portal.kernel.repository.LocalRepository fromLocalRepository,
com.liferay.portal.kernel.repository.LocalRepository toLocalRepository)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
com.liferay.portal.kernel.exception.PortalExceptioncom.liferay.portal.kernel.exception.SystemExceptionprotected com.liferay.portal.kernel.repository.LocalRepository getFileEntryLocalRepository(long fileEntryId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
com.liferay.portal.kernel.exception.PortalExceptioncom.liferay.portal.kernel.exception.SystemExceptionprotected com.liferay.portal.kernel.repository.LocalRepository getFileVersionLocalRepository(long fileVersionId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
com.liferay.portal.kernel.exception.PortalExceptioncom.liferay.portal.kernel.exception.SystemExceptionprotected com.liferay.portal.kernel.repository.LocalRepository getFolderLocalRepository(long folderId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
com.liferay.portal.kernel.exception.PortalExceptioncom.liferay.portal.kernel.exception.SystemExceptionprotected com.liferay.portal.kernel.repository.LocalRepository getFolderLocalRepository(long folderId,
long groupId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
com.liferay.portal.kernel.exception.PortalExceptioncom.liferay.portal.kernel.exception.SystemExceptionprotected com.liferay.portal.kernel.repository.LocalRepository getLocalRepository(long repositoryId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
com.liferay.portal.kernel.exception.PortalExceptioncom.liferay.portal.kernel.exception.SystemExceptionprotected com.liferay.portal.kernel.repository.model.FileEntry moveFileEntries(long userId,
long fileEntryId,
long newFolderId,
com.liferay.portal.kernel.repository.LocalRepository fromLocalRepository,
com.liferay.portal.kernel.repository.LocalRepository toLocalRepository,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
com.liferay.portal.kernel.exception.PortalExceptioncom.liferay.portal.kernel.exception.SystemExceptionprotected com.liferay.portal.kernel.repository.model.Folder moveFolders(long userId,
long folderId,
long parentFolderId,
com.liferay.portal.kernel.repository.LocalRepository sourceLocalRepository,
com.liferay.portal.kernel.repository.LocalRepository destinationLocalRepository,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
com.liferay.portal.kernel.exception.PortalExceptioncom.liferay.portal.kernel.exception.SystemException