@CTAware @ProviderType @Transactional(isolation=PORTAL, rollbackFor={PortalException.class,SystemException.class}) public interface DLAppLocalService extends BaseLocalService
DLAppLocalServiceUtil
Modifier and Type | Method and Description |
---|---|
FileEntry |
addFileEntry(long userId,
long repositoryId,
long folderId,
String sourceFileName,
String mimeType,
byte[] bytes,
ServiceContext serviceContext) |
FileEntry |
addFileEntry(long userId,
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 based on a byte array.
|
FileEntry |
addFileEntry(long userId,
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 based on a
File object. |
FileEntry |
addFileEntry(long userId,
long repositoryId,
long folderId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
InputStream inputStream,
long size,
ServiceContext serviceContext)
Adds a file entry and associated metadata based on an
InputStream
object. |
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,
String name,
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 |
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 |
deleteFileVersion(long fileVersionId)
Deletes the file version.
|
void |
deleteFolder(long folderId)
Deletes the folder and all of its subfolders and file entries.
|
FileEntry |
getFileEntry(long fileEntryId)
Returns the file entry with the primary key.
|
FileEntry |
getFileEntry(long groupId,
long folderId,
String title)
Returns the file entry with the title in the folder.
|
FileEntry |
getFileEntryByUuidAndGroupId(String uuid,
long groupId)
Returns the file entry with the UUID and group.
|
FileShortcut |
getFileShortcut(long fileShortcutId)
Returns the file shortcut with the primary key.
|
FileVersion |
getFileVersion(long fileVersionId)
Returns the file version with the primary key.
|
Folder |
getFolder(long folderId)
Returns the folder with the primary key.
|
Folder |
getFolder(long repositoryId,
long parentFolderId,
String name)
Returns the folder with the name in the parent folder.
|
Folder |
getMountFolder(long repositoryId)
Returns the mount folder of the repository with the primary key.
|
String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
FileEntry |
moveFileEntry(long userId,
long fileEntryId,
long newFolderId,
ServiceContext serviceContext)
Moves the file entry to the new folder.
|
Folder |
moveFolder(long userId,
long folderId,
long parentFolderId,
ServiceContext serviceContext) |
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,
String[] assetTagNames,
long[] assetLinkEntryIds)
Updates the file entry's asset replacing its asset categories, tags, and
links.
|
FileEntry |
updateFileEntry(long userId,
long fileEntryId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
DLVersionNumberIncrease dlVersionNumberIncrease,
byte[] bytes,
ServiceContext serviceContext)
Updates a file entry and associated metadata based on a byte array
object.
|
FileEntry |
updateFileEntry(long userId,
long fileEntryId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
DLVersionNumberIncrease dlVersionNumberIncrease,
File file,
ServiceContext serviceContext)
Updates a file entry and associated metadata based on a
File
object. |
FileEntry |
updateFileEntry(long userId,
long fileEntryId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
DLVersionNumberIncrease dlVersionNumberIncrease,
InputStream inputStream,
long size,
ServiceContext serviceContext)
Updates a file entry and associated metadata based on an
InputStream object. |
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.
|
Folder |
updateFolder(long folderId,
long parentFolderId,
String name,
String description,
ServiceContext serviceContext)
Updates the folder.
|
FileEntry addFileEntry(long userId, long repositoryId, long folderId, String sourceFileName, String mimeType, byte[] bytes, ServiceContext serviceContext) throws PortalException
PortalException
FileEntry addFileEntry(long userId, long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String description, 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 a portal exception occurredFileEntry addFileEntry(long userId, long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String description, String changeLog, 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 a portal exception occurredFileEntry addFileEntry(long userId, long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String description, String changeLog, InputStream inputStream, 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 loginputStream
- 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 a portal exception occurredFileShortcut 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 a portal exception occurredFolder addFolder(long userId, long repositoryId, long parentFolderId, String name, 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 a portal exception occurredvoid deleteAll(long repositoryId) throws PortalException
repositoryId
- the primary key of the data's repositoryPortalException
- if a portal exception occurredvoid deleteAllRepositories(long groupId) throws PortalException
PortalException
void deleteFileEntry(long fileEntryId) throws PortalException
fileEntryId
- the primary key of the file entryPortalException
- if a portal exception occurredvoid deleteFileShortcut(FileShortcut fileShortcut) throws PortalException
fileShortcut
- the file shortcutPortalException
- if a portal exception occurredvoid deleteFileShortcut(long fileShortcutId) throws PortalException
fileShortcutId
- the primary key of the file shortcutPortalException
- if a portal exception occurredvoid deleteFileShortcuts(long toFileEntryId) throws PortalException
toFileEntryId
- the primary key of the associated file entryPortalException
- if a portal exception occurredvoid deleteFileVersion(long fileVersionId) throws PortalException
fileVersionId
- the primary key of the file versionPortalException
- if a portal exception occurredvoid deleteFolder(long folderId) throws PortalException
folderId
- the primary key of the folderPortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) FileEntry getFileEntry(long fileEntryId) throws PortalException
fileEntryId
- the primary key of the file entryPortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) FileEntry getFileEntry(long groupId, long folderId, 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 a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) FileEntry getFileEntryByUuidAndGroupId(String uuid, long groupId) throws PortalException
uuid
- the file entry's UUIDgroupId
- the primary key of the file entry's groupPortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) FileShortcut getFileShortcut(long fileShortcutId) throws PortalException
fileShortcutId
- the primary key of the file shortcutPortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) FileVersion getFileVersion(long fileVersionId) throws PortalException
fileVersionId
- the primary key of the file versionPortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) Folder getFolder(long folderId) throws PortalException
folderId
- the primary key of the folderPortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) Folder getFolder(long repositoryId, long parentFolderId, 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 a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) Folder getMountFolder(long repositoryId) throws PortalException
repositoryId
- the primary key of the repositoryPortalException
- if a portal exception occurredString getOSGiServiceIdentifier()
FileEntry 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 a portal exception occurredFolder moveFolder(long userId, long folderId, long parentFolderId, ServiceContext serviceContext) throws PortalException
PortalException
void 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 a portal exception occurredvoid 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 a portal exception occurredvoid 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 a portal exception occurredvoid 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 a portal exception occurredvoid updateAsset(long userId, FileEntry fileEntry, FileVersion fileVersion, long[] assetCategoryIds, 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 a portal exception occurredFileEntry updateFileEntry(long userId, long fileEntryId, String sourceFileName, String mimeType, String title, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, 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
)dlVersionNumberIncrease
- the kind of version number increase to
apply for these changes.bytes
- the file's data (optionally null
)serviceContext
- the service context to be applied. Can set the
asset category IDs, asset tag names, and expando bridge
attributes for the file entry. In a Liferay repository, it may
include: PortalException
- if a portal exception occurredFileEntry updateFileEntry(long userId, long fileEntryId, String sourceFileName, String mimeType, String title, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, 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
)dlVersionNumberIncrease
- the kind of version number increase to
apply for these changes.file
- the file's data (optionally null
)serviceContext
- the service context to be applied. Can set the
asset category IDs, asset tag names, and expando bridge
attributes for the file entry. In a Liferay repository, it may
include: PortalException
- if a portal exception occurredFileEntry updateFileEntry(long userId, long fileEntryId, String sourceFileName, String mimeType, String title, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, InputStream inputStream, 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
)dlVersionNumberIncrease
- the kind of version number increase to
apply for these changes.inputStream
- 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 a portal exception occurredFileShortcut 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 a portal exception occurredvoid 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 portal exception occurredFolder updateFolder(long folderId, long parentFolderId, String name, 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 a portal exception occurred