@ProviderType @Transactional(isolation=PORTAL, rollbackFor={PortalException.class,SystemException.class}) public interface DLAppLocalService extends BaseLocalService
DLAppLocalServiceUtil,
com.liferay.portlet.documentlibrary.service.base.DLAppLocalServiceBaseImpl,
com.liferay.portlet.documentlibrary.service.impl.DLAppLocalServiceImpl| Modifier and Type | Method and Description |
|---|---|
FileEntry |
addFileEntry(long userId,
long repositoryId,
long folderId,
java.lang.String sourceFileName,
java.lang.String mimeType,
byte[] bytes,
ServiceContext serviceContext) |
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,
ServiceContext serviceContext)
Adds a file entry and associated metadata based on a byte array.
|
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,
ServiceContext serviceContext)
Adds a file entry and associated metadata based on a
File object. |
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,
ServiceContext serviceContext)
Adds a file entry and associated metadata based on an
InputStream
object. |
DLFileRank |
addFileRank(long repositoryId,
long companyId,
long userId,
long fileEntryId,
ServiceContext serviceContext)
Adds the file rank to the existing file entry.
|
FileShortcut |
addFileShortcut(long userId,
long repositoryId,
long folderId,
long toFileEntryId,
ServiceContext serviceContext)
Adds the file shortcut to the existing file entry.
|
Folder |
addFolder(long userId,
long repositoryId,
long parentFolderId,
java.lang.String name,
java.lang.String description,
ServiceContext serviceContext)
Adds a folder.
|
void |
deleteAll(long repositoryId)
Delete all data associated to the given repository.
|
void |
deleteAllRepositories(long groupId) |
void |
deleteFileEntry(long fileEntryId)
Deletes the file entry.
|
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(FileShortcut fileShortcut)
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.
|
java.lang.String |
getBeanIdentifier()
Returns the Spring bean ID for this bean.
|
FileEntry |
getFileEntry(long fileEntryId)
Returns the file entry with the primary key.
|
FileEntry |
getFileEntry(long groupId,
long folderId,
java.lang.String title)
Returns the file entry with the title in the folder.
|
FileEntry |
getFileEntryByUuidAndGroupId(java.lang.String uuid,
long groupId)
Returns the file entry with the UUID and group.
|
java.util.List<DLFileRank> |
getFileRanks(long repositoryId,
long userId)
Returns the file ranks from the user.
|
FileShortcut |
getFileShortcut(long fileShortcutId)
Returns the file shortcut with the primary key.
|
FileVersion |
getFileVersion(long fileVersionId)
Returns the file version with the primary key.
|
Folder |
getFolder(long folderId)
Returns the folder with the primary key.
|
Folder |
getFolder(long repositoryId,
long parentFolderId,
java.lang.String name)
Returns the folder with the name in the parent folder.
|
Folder |
getMountFolder(long repositoryId)
Returns the mount folder of the repository with the primary key.
|
FileEntry |
moveFileEntry(long userId,
long fileEntryId,
long newFolderId,
ServiceContext serviceContext)
Moves the file entry to the new folder.
|
FileEntry |
moveFileEntryFromTrash(long userId,
long fileEntryId,
long newFolderId,
ServiceContext serviceContext)
Deprecated.
As of 7.0.0, replaced by
RepositoryTrashUtil#moveFileEntryFromTrash(long, long, long,
long, ServiceContext) |
FileEntry |
moveFileEntryToTrash(long userId,
long fileEntryId)
Deprecated.
As of 7.0.0, replaced by
RepositoryTrashUtil#moveFileEntryToTrash(long, long, long) |
Folder |
moveFolder(long userId,
long folderId,
long parentFolderId,
ServiceContext serviceContext) |
void |
restoreFileEntryFromTrash(long userId,
long fileEntryId)
Deprecated.
As of 7.0.0, replaced by
RepositoryTrashUtil#restoreFileEntryFromTrash(long, long,
long) |
void |
setBeanIdentifier(java.lang.String beanIdentifier)
Sets the Spring bean ID for this bean.
|
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,
FileEntry fileEntry,
FileVersion fileVersion,
long[] assetCategoryIds,
java.lang.String[] assetTagNames,
long[] assetLinkEntryIds)
Updates the file entry's asset replacing its asset categories, tags, and
links.
|
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,
ServiceContext serviceContext)
Updates a file entry and associated metadata based on a byte array
object.
|
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,
ServiceContext serviceContext)
Updates a file entry and associated metadata based on a
File
object. |
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,
ServiceContext serviceContext)
Updates a file entry and associated metadata based on an
InputStream object. |
DLFileRank |
updateFileRank(long repositoryId,
long companyId,
long userId,
long fileEntryId,
ServiceContext serviceContext)
Updates a file rank to the existing file entry.
|
FileShortcut |
updateFileShortcut(long userId,
long fileShortcutId,
long folderId,
long toFileEntryId,
ServiceContext serviceContext)
Updates a file shortcut to the existing file entry.
|
void |
updateFileShortcuts(long oldToFileEntryId,
long newToFileEntryId)
Updates all file shortcuts to the existing file entry to the new file
entry.
|
void |
updateFileShortcuts(long toRepositoryId,
long oldToFileEntryId,
long newToFileEntryId)
Deprecated.
|
Folder |
updateFolder(long folderId,
long parentFolderId,
java.lang.String name,
java.lang.String description,
ServiceContext serviceContext)
Updates the folder.
|
FileEntry addFileEntry(long userId, long repositoryId, long folderId, java.lang.String sourceFileName, java.lang.String mimeType, byte[] bytes, ServiceContext serviceContext) throws PortalException
PortalExceptionFileEntry 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, ServiceContext serviceContext) throws PortalException
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: PortalException - if the parent folder could not be found or if the
file entry's information was invalidFileEntry 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, ServiceContext serviceContext) throws PortalException
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: PortalException - if the parent folder could not be found or if the
file entry's information was invalidFileEntry 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, ServiceContext serviceContext) throws PortalException
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: PortalException - if the parent folder could not be found or if the
file entry's information was invalidDLFileRank addFileRank(long repositoryId, long companyId, long userId, long fileEntryId, ServiceContext serviceContext)
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 appliedFileShortcut addFileShortcut(long userId, long repositoryId, long folderId, long toFileEntryId, ServiceContext serviceContext) throws PortalException
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.PortalException - if the parent folder or file entry could not be
found, or if the file shortcut's information was invalidFolder addFolder(long userId, long repositoryId, long parentFolderId, java.lang.String name, java.lang.String description, ServiceContext serviceContext) throws PortalException
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 repositoryPortalException - if the parent folder could not be found or if the
new folder's information was invalidvoid deleteAll(long repositoryId)
throws PortalException
repositoryId - the primary key of the data's repositoryPortalException - if the repository could not be foundvoid deleteAllRepositories(long groupId)
throws PortalException
PortalExceptionvoid deleteFileEntry(long fileEntryId)
throws PortalException
fileEntryId - the primary key of the file entryPortalException - if the file entry could not be foundvoid deleteFileRanksByFileEntryId(long fileEntryId)
fileEntryId - the primary key of the file entryvoid deleteFileRanksByUserId(long userId)
userId - the primary key of the uservoid deleteFileShortcut(FileShortcut fileShortcut) throws PortalException
fileShortcut - the file shortcutPortalException - if the file shortcut could not be foundvoid deleteFileShortcut(long fileShortcutId)
throws PortalException
fileShortcutId - the primary key of the file shortcutPortalException - if the file shortcut could not be foundvoid deleteFileShortcuts(long toFileEntryId)
throws PortalException
toFileEntryId - the primary key of the associated file entryPortalException - if the file shortcut for the file entry could not
be foundvoid deleteFolder(long folderId)
throws PortalException
folderId - the primary key of the folderPortalException - if the folder could not be foundjava.lang.String getBeanIdentifier()
@Transactional(propagation=SUPPORTS, readOnly=true) FileEntry getFileEntry(long fileEntryId) throws PortalException
fileEntryId - the primary key of the file entryPortalException - if the file entry could not be found@Transactional(propagation=SUPPORTS, readOnly=true) FileEntry getFileEntry(long groupId, long folderId, java.lang.String title) throws PortalException
groupId - the primary key of the file entry's groupfolderId - the primary key of the file entry's foldertitle - the file entry's titlePortalException - if the file entry could not be found@Transactional(propagation=SUPPORTS, readOnly=true) FileEntry getFileEntryByUuidAndGroupId(java.lang.String uuid, long groupId) throws PortalException
uuid - the file entry's UUIDgroupId - the primary key of the file entry's groupPortalException - if the file entry could not be found@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<DLFileRank> getFileRanks(long repositoryId, long userId)
repositoryId - the primary key of the repositoryuserId - the primary key of the user@Transactional(propagation=SUPPORTS, readOnly=true) FileShortcut getFileShortcut(long fileShortcutId) throws PortalException
fileShortcutId - the primary key of the file shortcutPortalException - if the file shortcut could not be found@Transactional(propagation=SUPPORTS, readOnly=true) FileVersion getFileVersion(long fileVersionId) throws PortalException
fileVersionId - the primary key of the file versionPortalException - if the file version could not be found@Transactional(propagation=SUPPORTS, readOnly=true) Folder getFolder(long folderId) throws PortalException
folderId - the primary key of the folderPortalException - if the folder could not be found@Transactional(propagation=SUPPORTS, readOnly=true) Folder getFolder(long repositoryId, long parentFolderId, java.lang.String name) throws PortalException
repositoryId - the primary key of the folder's repositoryparentFolderId - the primary key of the folder's parent foldername - the folder's namePortalException - if the folder could not be found@Transactional(propagation=SUPPORTS, readOnly=true) Folder getMountFolder(long repositoryId) throws PortalException
repositoryId - the primary key of the repositoryPortalException - if the repository or mount folder could not be
foundFileEntry moveFileEntry(long userId, long fileEntryId, long newFolderId, ServiceContext serviceContext) throws PortalException
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 appliedPortalException - if the file entry or the new folder could not be
found@Deprecated FileEntry moveFileEntryFromTrash(long userId, long fileEntryId, long newFolderId, ServiceContext serviceContext) throws PortalException
RepositoryTrashUtil#moveFileEntryFromTrash(long, long, long,
long, ServiceContext)PortalException@Deprecated FileEntry moveFileEntryToTrash(long userId, long fileEntryId) throws PortalException
RepositoryTrashUtil#moveFileEntryToTrash(long, long, long)PortalExceptionFolder moveFolder(long userId, long folderId, long parentFolderId, ServiceContext serviceContext) throws PortalException
PortalException@Deprecated
void restoreFileEntryFromTrash(long userId,
long fileEntryId)
throws PortalException
RepositoryTrashUtil#restoreFileEntryFromTrash(long, long,
long)PortalExceptionvoid setBeanIdentifier(java.lang.String beanIdentifier)
beanIdentifier - the Spring bean ID for this beanvoid subscribeFileEntryType(long userId,
long groupId,
long fileEntryTypeId)
throws PortalException
userId - the primary key of the usergroupId - the primary key of the file entry type's groupfileEntryTypeId - the primary key of the file entry typePortalException - if the user or group could not be foundvoid subscribeFolder(long userId,
long groupId,
long folderId)
throws PortalException
userId - the primary key of the usergroupId - the primary key of the folder's groupfolderId - the primary key of the folderPortalException - if the user or group could not be foundvoid unsubscribeFileEntryType(long userId,
long groupId,
long fileEntryTypeId)
throws PortalException
userId - the primary key of the usergroupId - the primary key of the file entry type's groupfileEntryTypeId - the primary key of the file entry typePortalException - if the user or group could not be foundvoid unsubscribeFolder(long userId,
long groupId,
long folderId)
throws PortalException
userId - the primary key of the usergroupId - the primary key of the folder's groupfolderId - the primary key of the folderPortalException - if the user or group could not be foundvoid updateAsset(long userId,
FileEntry fileEntry,
FileVersion fileVersion,
long[] assetCategoryIds,
java.lang.String[] assetTagNames,
long[] assetLinkEntryIds)
throws PortalException
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 entriesPortalException - if the file entry or version could not be foundFileEntry 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, ServiceContext serviceContext) throws PortalException
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: PortalException - if the file entry could not be foundFileEntry 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, ServiceContext serviceContext) throws PortalException
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: PortalException - if the file entry could not be foundFileEntry 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, ServiceContext serviceContext) throws PortalException
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: PortalException - if the file entry could not be foundDLFileRank updateFileRank(long repositoryId, long companyId, long userId, long fileEntryId, ServiceContext serviceContext)
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 appliedFileShortcut updateFileShortcut(long userId, long fileShortcutId, long folderId, long toFileEntryId, ServiceContext serviceContext) throws PortalException
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.PortalException - if the file shortcut, folder, or file entry could
not be foundvoid updateFileShortcuts(long oldToFileEntryId,
long newToFileEntryId)
throws PortalException
oldToFileEntryId - the primary key of the old file entry pointed tonewToFileEntryId - the primary key of the new file entry to point
toPortalException - if a file entry for any one of the primary keys
could not be found@Deprecated
void updateFileShortcuts(long toRepositoryId,
long oldToFileEntryId,
long newToFileEntryId)
throws PortalException
updateFileShortcuts(long,
long)PortalExceptionFolder updateFolder(long folderId, long parentFolderId, java.lang.String name, java.lang.String description, ServiceContext serviceContext) throws PortalException
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).PortalException - if the current or new parent folder could not be
found, or if the new parent folder's information was invalid