Class DLAppLocalServiceWrapper
- All Implemented Interfaces:
DLAppLocalService
,BaseLocalService
,ServiceWrapper<DLAppLocalService>
DLAppLocalService
.- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddFileEntry
(long userId, long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String description, String changeLog, File file, ServiceContext serviceContext) Deprecated.addFileEntry
(String externalReferenceCode, long userId, long repositoryId, long folderId, String sourceFileName, String mimeType, byte[] bytes, Date displayDate, Date expirationDate, Date reviewDate, ServiceContext serviceContext) addFileEntry
(String externalReferenceCode, long userId, long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, byte[] bytes, Date displayDate, Date expirationDate, Date reviewDate, ServiceContext serviceContext) Adds a file entry and associated metadata based on a byte array.addFileEntry
(String externalReferenceCode, long userId, long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, File file, Date displayDate, Date expirationDate, Date reviewDate, ServiceContext serviceContext) Adds a file entry and associated metadata based on aFile
object.addFileEntry
(String externalReferenceCode, long userId, long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, InputStream inputStream, long size, Date displayDate, Date expirationDate, Date reviewDate, ServiceContext serviceContext) Adds a file entry and associated metadata based on anInputStream
object.addFileShortcut
(String externalReferenceCode, long userId, long repositoryId, long folderId, long toFileEntryId, ServiceContext serviceContext) Adds the file shortcut to the existing file entry.addFolder
(String externalReferenceCode, 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
deleteFileEntryByExternalReferenceCode
(String externalReferenceCode, long groupId) void
deleteFileShortcut
(long fileShortcutId) Deletes the file shortcut.void
deleteFileShortcut
(FileShortcut fileShortcut) 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.fetchFileEntryByExternalReferenceCode
(long groupId, String externalReferenceCode) Returns the document library file entry with the matching external reference code and group.fetchFileShortcut
(long fileShortcutId) fetchFileShortcutByExternalReferenceCode
(String externalReferenceCode, long groupId) fetchFolderByExternalReferenceCode
(String externalReferenceCode, long groupId) getFileEntry
(long fileEntryId) Returns the file entry with the primary key.getFileEntry
(long groupId, long folderId, String title) Returns the file entry with the title in the folder.getFileEntryByExternalReferenceCode
(String externalReferenceCode, long groupId) Returns the file entry with the external reference code.getFileEntryByFileName
(long groupId, long folderId, String fileName) Returns the file entry with the file name in the folder.getFileEntryByUuidAndGroupId
(String uuid, long groupId) Returns the file entry with the UUID and group.getFileShortcut
(long fileShortcutId) Returns the file shortcut with the primary key.getFileShortcutByExternalReferenceCode
(String externalReferenceCode, long groupId) getFileVersion
(long fileVersionId) Returns the file version with the primary key.getFolder
(long folderId) Returns the folder with the primary key.Returns the folder with the name in the parent folder.getFolderByExternalReferenceCode
(String externalReferenceCode, long groupId) getMountFolder
(long repositoryId) Returns the mount folder of the repository with the primary key.Returns the OSGi service identifier.moveFileEntry
(long userId, long fileEntryId, long newFolderId, ServiceContext serviceContext) Moves the file entry to the new folder.moveFolder
(long userId, long folderId, long parentFolderId, ServiceContext serviceContext) void
setWrappedService
(DLAppLocalService dlAppLocalService) void
subscribeFileEntry
(long userId, long groupId, long fileEntryId) 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
unsubscribeFileEntry
(long userId, long groupId, long fileEntryId) 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.updateFileEntry
(long userId, long fileEntryId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, byte[] bytes, Date displayDate, Date expirationDate, Date reviewDate, ServiceContext serviceContext) Updates a file entry and associated metadata based on a byte array object.updateFileEntry
(long userId, long fileEntryId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, File file, Date displayDate, Date expirationDate, Date reviewDate, ServiceContext serviceContext) Updates a file entry and associated metadata based on aFile
object.updateFileEntry
(long userId, long fileEntryId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, InputStream inputStream, long size, Date displayDate, Date expirationDate, Date reviewDate, ServiceContext serviceContext) Updates a file entry and associated metadata based on anInputStream
object.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.updateFolder
(long folderId, long parentFolderId, String name, String description, ServiceContext serviceContext) Updates the folder.
-
Constructor Details
-
DLAppLocalServiceWrapper
public DLAppLocalServiceWrapper() -
DLAppLocalServiceWrapper
-
-
Method Details
-
addFileEntry
@Deprecated public FileEntry addFileEntry(long userId, long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String description, String changeLog, File file, ServiceContext serviceContext) throws PortalException Deprecated.As of Cavanaugh (7.4.x), replaced byaddFileEntry(String, long, long, long, String, String, String, String, String, String, File, Date, Date expirationDate, Date, ServiceContext)
Adds a file entry and associated metadata based on aFile
object.This method takes two file names, the
sourceFileName
and thetitle
. ThesourceFileName
corresponds to the name of the actual file being uploaded. Thetitle
corresponds to a name the client wishes to assign this file after it has been uploaded to the portal. If it isnull
, thesourceFileName
will be used.- Specified by:
addFileEntry
in interfaceDLAppLocalService
- Parameters:
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 (optionallynull
)description
- the file's descriptionchangeLog
- the file's version change logfile
- the file's data (optionallynull
)serviceContext
- the service context to be applied. Can set the asset category IDs, asset tag names, and expando bridge attributes for the file entry. In a Liferay repository, it may include:- fileEntryTypeId - ID for a custom file entry type
- fieldsMap - mapping for fields associated with a custom file entry type
- Returns:
- the file entry
- Throws:
PortalException
- if a portal exception occurredPortalException
-
addFileEntry
public FileEntry addFileEntry(String externalReferenceCode, long userId, long repositoryId, long folderId, String sourceFileName, String mimeType, byte[] bytes, Date displayDate, Date expirationDate, Date reviewDate, ServiceContext serviceContext) throws PortalException - Specified by:
addFileEntry
in interfaceDLAppLocalService
- Throws:
PortalException
-
addFileEntry
public FileEntry addFileEntry(String externalReferenceCode, long userId, long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, byte[] bytes, Date displayDate, Date expirationDate, Date reviewDate, ServiceContext serviceContext) throws PortalException Adds a file entry and associated metadata based on a byte array.This method takes two file names, the
sourceFileName
and thetitle
. ThesourceFileName
corresponds to the name of the actual file being uploaded. Thetitle
corresponds to a name the client wishes to assign this file after it has been uploaded to the portal. If it isnull
, thesourceFileName
will be used.- Specified by:
addFileEntry
in interfaceDLAppLocalService
- Parameters:
externalReferenceCode
- the file entry's external reference codeuserId
- 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 (optionallynull
)description
- the file's descriptionchangeLog
- the file's version change logbytes
- the file's data (optionallynull
)displayDate
- the file's display date (optionallynull
)expirationDate
- the file's expiration date (optionallynull
)reviewDate
- the file's review Date (optionallynull
)serviceContext
- the service context to be applied. Can set the asset category IDs, asset tag names, and expando bridge attributes for the file entry. In a Liferay repository, it may include:- fileEntryTypeId - ID for a custom file entry type
- fieldsMap - mapping for fields associated with a custom file entry type
- Returns:
- the file entry
- Throws:
PortalException
- if a portal exception occurredPortalException
-
addFileEntry
public FileEntry addFileEntry(String externalReferenceCode, long userId, long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, File file, Date displayDate, Date expirationDate, Date reviewDate, ServiceContext serviceContext) throws PortalException Adds a file entry and associated metadata based on aFile
object.This method takes two file names, the
sourceFileName
and thetitle
. ThesourceFileName
corresponds to the name of the actual file being uploaded. Thetitle
corresponds to a name the client wishes to assign this file after it has been uploaded to the portal. If it isnull
, thesourceFileName
will be used.- Specified by:
addFileEntry
in interfaceDLAppLocalService
- Parameters:
externalReferenceCode
- the file entry's external reference codeuserId
- 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 (optionallynull
)description
- the file's descriptionchangeLog
- the file's version change logfile
- the file's data (optionallynull
)displayDate
- the file's display date (optionallynull
)expirationDate
- the file's expiration date (optionallynull
)reviewDate
- the file's review Date (optionallynull
)serviceContext
- the service context to be applied. Can set the asset category IDs, asset tag names, and expando bridge attributes for the file entry. In a Liferay repository, it may include:- fileEntryTypeId - ID for a custom file entry type
- fieldsMap - mapping for fields associated with a custom file entry type
- Returns:
- the file entry
- Throws:
PortalException
- if a portal exception occurredPortalException
-
addFileEntry
public FileEntry addFileEntry(String externalReferenceCode, long userId, long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, InputStream inputStream, long size, Date displayDate, Date expirationDate, Date reviewDate, ServiceContext serviceContext) throws PortalException Adds a file entry and associated metadata based on anInputStream
object.This method takes two file names, the
sourceFileName
and thetitle
. ThesourceFileName
corresponds to the name of the actual file being uploaded. Thetitle
corresponds to a name the client wishes to assign this file after it has been uploaded to the portal. If it isnull
, thesourceFileName
will be used.- Specified by:
addFileEntry
in interfaceDLAppLocalService
- Parameters:
externalReferenceCode
- the file entry's external reference codeuserId
- 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 (optionallynull
)description
- the file's descriptionchangeLog
- the file's version change loginputStream
- the file's data (optionallynull
)size
- the file's size (optionally0
)displayDate
- the file's display date (optionallynull
)expirationDate
- the file's expiration date (optionallynull
)reviewDate
- the file's review Date (optionallynull
)serviceContext
- the service context to be applied. Can set the asset category IDs, asset tag names, and expando bridge attributes for the file entry. In a Liferay repository, it may include:- fileEntryTypeId - ID for a custom file entry type
- fieldsMap - mapping for fields associated with a custom file entry type
- Returns:
- the file entry
- Throws:
PortalException
- if a portal exception occurredPortalException
-
addFileShortcut
public FileShortcut addFileShortcut(String externalReferenceCode, long userId, long repositoryId, long folderId, long toFileEntryId, ServiceContext serviceContext) throws PortalException Adds the file shortcut to the existing file entry. This method is only supported by the Liferay repository.- Specified by:
addFileShortcut
in interfaceDLAppLocalService
- Parameters:
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.- Returns:
- the file shortcut
- Throws:
PortalException
- if a portal exception occurredPortalException
-
addFolder
public Folder addFolder(String externalReferenceCode, long userId, long repositoryId, long parentFolderId, String name, String description, ServiceContext serviceContext) throws PortalException Adds a folder.- Specified by:
addFolder
in interfaceDLAppLocalService
- Parameters:
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 repository- Returns:
- the folder
- Throws:
PortalException
- if a portal exception occurredPortalException
-
deleteAll
Delete all data associated to the given repository. This method is only supported by the Liferay repository.- Specified by:
deleteAll
in interfaceDLAppLocalService
- Parameters:
repositoryId
- the primary key of the data's repository- Throws:
PortalException
- if a portal exception occurredPortalException
-
deleteAllRepositories
- Specified by:
deleteAllRepositories
in interfaceDLAppLocalService
- Throws:
PortalException
-
deleteFileEntry
Deletes the file entry.- Specified by:
deleteFileEntry
in interfaceDLAppLocalService
- Parameters:
fileEntryId
- the primary key of the file entry- Throws:
PortalException
- if a portal exception occurredPortalException
-
deleteFileEntryByExternalReferenceCode
public void deleteFileEntryByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException - Specified by:
deleteFileEntryByExternalReferenceCode
in interfaceDLAppLocalService
- Throws:
PortalException
-
deleteFileShortcut
Deletes the file shortcut. This method is only supported by the Liferay repository.- Specified by:
deleteFileShortcut
in interfaceDLAppLocalService
- Parameters:
fileShortcut
- the file shortcut- Throws:
PortalException
- if a portal exception occurredPortalException
-
deleteFileShortcut
Deletes the file shortcut. This method is only supported by the Liferay repository.- Specified by:
deleteFileShortcut
in interfaceDLAppLocalService
- Parameters:
fileShortcutId
- the primary key of the file shortcut- Throws:
PortalException
- if a portal exception occurredPortalException
-
deleteFileShortcuts
Deletes all file shortcuts associated to the file entry. This method is only supported by the Liferay repository.- Specified by:
deleteFileShortcuts
in interfaceDLAppLocalService
- Parameters:
toFileEntryId
- the primary key of the associated file entry- Throws:
PortalException
- if a portal exception occurredPortalException
-
deleteFileVersion
Deletes the file version. File versions can only be deleted if it is approved and there are other approved file versions available.- Specified by:
deleteFileVersion
in interfaceDLAppLocalService
- Parameters:
fileVersionId
- the primary key of the file version- Throws:
PortalException
- if a portal exception occurredPortalException
-
deleteFolder
Deletes the folder and all of its subfolders and file entries.- Specified by:
deleteFolder
in interfaceDLAppLocalService
- Parameters:
folderId
- the primary key of the folder- Throws:
PortalException
- if a portal exception occurredPortalException
-
fetchFileEntryByExternalReferenceCode
public FileEntry fetchFileEntryByExternalReferenceCode(long groupId, String externalReferenceCode) throws PortalException Returns the document library file entry with the matching external reference code and group.- Specified by:
fetchFileEntryByExternalReferenceCode
in interfaceDLAppLocalService
- Parameters:
groupId
- the primary key of the file entry's groupexternalReferenceCode
- the file entry's external reference code- Returns:
- the matching document library file entry, or
null
if a matching document library file entry could not be found - Throws:
PortalException
-
fetchFileShortcut
- Specified by:
fetchFileShortcut
in interfaceDLAppLocalService
- Throws:
PortalException
-
fetchFileShortcutByExternalReferenceCode
public FileShortcut fetchFileShortcutByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException - Specified by:
fetchFileShortcutByExternalReferenceCode
in interfaceDLAppLocalService
- Throws:
PortalException
-
fetchFolderByExternalReferenceCode
public Folder fetchFolderByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException - Specified by:
fetchFolderByExternalReferenceCode
in interfaceDLAppLocalService
- Throws:
PortalException
-
getFileEntry
Returns the file entry with the primary key.- Specified by:
getFileEntry
in interfaceDLAppLocalService
- Parameters:
fileEntryId
- the primary key of the file entry- Returns:
- the file entry with the primary key
- Throws:
PortalException
- if a portal exception occurredPortalException
-
getFileEntry
Returns the file entry with the title in the folder.- Specified by:
getFileEntry
in interfaceDLAppLocalService
- Parameters:
groupId
- the primary key of the file entry's groupfolderId
- the primary key of the file entry's foldertitle
- the file entry's title- Returns:
- the file entry with the title in the folder
- Throws:
PortalException
- if a portal exception occurredPortalException
-
getFileEntryByExternalReferenceCode
public FileEntry getFileEntryByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException Returns the file entry with the external reference code.- Specified by:
getFileEntryByExternalReferenceCode
in interfaceDLAppLocalService
- Parameters:
groupId
- the primary key of the file entry's groupexternalReferenceCode
- the file entry's external reference code- Returns:
- the file entry with the external reference code
- Throws:
PortalException
- if a portal exception occurredPortalException
-
getFileEntryByFileName
public FileEntry getFileEntryByFileName(long groupId, long folderId, String fileName) throws PortalException Returns the file entry with the file name in the folder.- Specified by:
getFileEntryByFileName
in interfaceDLAppLocalService
- Parameters:
groupId
- the primary key of the file entry's groupfolderId
- the primary key of the file entry's folderfileName
- the file entry's file name- Returns:
- the file entry with the file name in the folder
- Throws:
PortalException
- if a portal exception occurredPortalException
-
getFileEntryByUuidAndGroupId
Returns the file entry with the UUID and group.- Specified by:
getFileEntryByUuidAndGroupId
in interfaceDLAppLocalService
- Parameters:
uuid
- the file entry's UUIDgroupId
- the primary key of the file entry's group- Returns:
- the file entry with the UUID and group
- Throws:
PortalException
- if a portal exception occurredPortalException
-
getFileShortcut
Returns the file shortcut with the primary key. This method is only supported by the Liferay repository.- Specified by:
getFileShortcut
in interfaceDLAppLocalService
- Parameters:
fileShortcutId
- the primary key of the file shortcut- Returns:
- the file shortcut with the primary key
- Throws:
PortalException
- if a portal exception occurredPortalException
-
getFileShortcutByExternalReferenceCode
public FileShortcut getFileShortcutByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException - Specified by:
getFileShortcutByExternalReferenceCode
in interfaceDLAppLocalService
- Throws:
PortalException
-
getFileVersion
Returns the file version with the primary key.- Specified by:
getFileVersion
in interfaceDLAppLocalService
- Parameters:
fileVersionId
- the primary key of the file version- Returns:
- the file version with the primary key
- Throws:
PortalException
- if a portal exception occurredPortalException
-
getFolder
Returns the folder with the primary key.- Specified by:
getFolder
in interfaceDLAppLocalService
- Parameters:
folderId
- the primary key of the folder- Returns:
- the folder with the primary key
- Throws:
PortalException
- if a portal exception occurredPortalException
-
getFolder
Returns the folder with the name in the parent folder.- Specified by:
getFolder
in interfaceDLAppLocalService
- Parameters:
repositoryId
- the primary key of the folder's repositoryparentFolderId
- the primary key of the folder's parent foldername
- the folder's name- Returns:
- the folder with the name in the parent folder
- Throws:
PortalException
- if a portal exception occurredPortalException
-
getFolderByExternalReferenceCode
public Folder getFolderByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException - Specified by:
getFolderByExternalReferenceCode
in interfaceDLAppLocalService
- Throws:
PortalException
-
getMountFolder
Returns the mount folder of the repository with the primary key. This method is only supported by the Liferay repository.- Specified by:
getMountFolder
in interfaceDLAppLocalService
- Parameters:
repositoryId
- the primary key of the repository- Returns:
- the folder used for mounting third-party repositories
- Throws:
PortalException
- if a portal exception occurredPortalException
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Specified by:
getOSGiServiceIdentifier
in interfaceDLAppLocalService
- Returns:
- the OSGi service identifier
-
moveFileEntry
public FileEntry moveFileEntry(long userId, long fileEntryId, long newFolderId, ServiceContext serviceContext) throws PortalException Moves the file entry to the new folder.- Specified by:
moveFileEntry
in interfaceDLAppLocalService
- Parameters:
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 applied- Returns:
- the file entry
- Throws:
PortalException
- if a portal exception occurredPortalException
-
moveFolder
public Folder moveFolder(long userId, long folderId, long parentFolderId, ServiceContext serviceContext) throws PortalException - Specified by:
moveFolder
in interfaceDLAppLocalService
- Throws:
PortalException
-
subscribeFileEntry
- Specified by:
subscribeFileEntry
in interfaceDLAppLocalService
- Throws:
PortalException
-
subscribeFileEntryType
public void subscribeFileEntryType(long userId, long groupId, long fileEntryTypeId) throws PortalException Subscribe the user to changes in documents of the file entry type. This method is only supported by the Liferay repository.- Specified by:
subscribeFileEntryType
in interfaceDLAppLocalService
- Parameters:
userId
- the primary key of the usergroupId
- the primary key of the file entry type's groupfileEntryTypeId
- the primary key of the file entry type- Throws:
PortalException
- if a portal exception occurredPortalException
-
subscribeFolder
Subscribe the user to document changes in the folder. This method is only supported by the Liferay repository.- Specified by:
subscribeFolder
in interfaceDLAppLocalService
- Parameters:
userId
- the primary key of the usergroupId
- the primary key of the folder's groupfolderId
- the primary key of the folder- Throws:
PortalException
- if a portal exception occurredPortalException
-
unsubscribeFileEntry
public void unsubscribeFileEntry(long userId, long groupId, long fileEntryId) throws PortalException - Specified by:
unsubscribeFileEntry
in interfaceDLAppLocalService
- Throws:
PortalException
-
unsubscribeFileEntryType
public void unsubscribeFileEntryType(long userId, long groupId, long fileEntryTypeId) throws PortalException Unsubscribe the user from changes in documents of the file entry type. This method is only supported by the Liferay repository.- Specified by:
unsubscribeFileEntryType
in interfaceDLAppLocalService
- Parameters:
userId
- the primary key of the usergroupId
- the primary key of the file entry type's groupfileEntryTypeId
- the primary key of the file entry type- Throws:
PortalException
- if a portal exception occurredPortalException
-
unsubscribeFolder
Unsubscribe the user from document changes in the folder. This method is only supported by the Liferay repository.- Specified by:
unsubscribeFolder
in interfaceDLAppLocalService
- Parameters:
userId
- the primary key of the usergroupId
- the primary key of the folder's groupfolderId
- the primary key of the folder- Throws:
PortalException
- if a portal exception occurredPortalException
-
updateAsset
public void updateAsset(long userId, FileEntry fileEntry, FileVersion fileVersion, long[] assetCategoryIds, String[] assetTagNames, long[] assetLinkEntryIds) throws PortalException Updates the file entry's asset replacing its asset categories, tags, and links.- Specified by:
updateAsset
in interfaceDLAppLocalService
- Parameters:
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 entries- Throws:
PortalException
- if a portal exception occurredPortalException
-
updateFileEntry
public FileEntry updateFileEntry(long userId, long fileEntryId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, byte[] bytes, Date displayDate, Date expirationDate, Date reviewDate, ServiceContext serviceContext) throws PortalException Updates a file entry and associated metadata based on a byte array object. If the file data isnull
, then only the associated metadata (i.e.,title
,description
, and parameters in theserviceContext
) will be updated.This method takes two file names, the
sourceFileName
and thetitle
. ThesourceFileName
corresponds to the name of the actual file being uploaded. Thetitle
corresponds to a name the client wishes to assign this file after it has been uploaded to the portal.- Specified by:
updateFileEntry
in interfaceDLAppLocalService
- Parameters:
userId
- the primary key of the userfileEntryId
- the primary key of the file entrysourceFileName
- the original file's name (optionallynull
)mimeType
- the file's MIME type (optionallynull
)title
- the new name to be assigned to the file (optionallynull
description
- the file's new descriptionchangeLog
- the file's version change log (optionallynull
)dlVersionNumberIncrease
- the kind of version number increase to apply for these changes.bytes
- the file's data (optionallynull
)displayDate
- the file's display date (optionallynull
)expirationDate
- the file's expiration date (optionallynull
)reviewDate
- the file's review date (optionallynull
)serviceContext
- the service context to be applied. Can set the asset category IDs, asset tag names, and expando bridge attributes for the file entry. In a Liferay repository, it may include:- fileEntryTypeId - ID for a custom file entry type
- fieldsMap - mapping for fields associated with a custom file entry type
- Returns:
- the file entry
- Throws:
PortalException
- if a portal exception occurredPortalException
-
updateFileEntry
public FileEntry updateFileEntry(long userId, long fileEntryId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, File file, Date displayDate, Date expirationDate, Date reviewDate, ServiceContext serviceContext) throws PortalException Updates a file entry and associated metadata based on aFile
object. If the file data isnull
, then only the associated metadata (i.e.,title
,description
, and parameters in theserviceContext
) will be updated.This method takes two file names, the
sourceFileName
and thetitle
. ThesourceFileName
corresponds to the name of the actual file being uploaded. Thetitle
corresponds to a name the client wishes to assign this file after it has been uploaded to the portal.- Specified by:
updateFileEntry
in interfaceDLAppLocalService
- Parameters:
userId
- the primary key of the userfileEntryId
- the primary key of the file entrysourceFileName
- the original file's name (optionallynull
)mimeType
- the file's MIME type (optionallynull
)title
- the new name to be assigned to the file (optionallynull
description
- the file's new descriptionchangeLog
- the file's version change log (optionallynull
)dlVersionNumberIncrease
- the kind of version number increase to apply for these changes.file
- the file's data (optionallynull
)displayDate
- the file's display date (optionallynull
)expirationDate
- the file's expiration date (optionallynull
)reviewDate
- the file's review date (optionallynull
)serviceContext
- the service context to be applied. Can set the asset category IDs, asset tag names, and expando bridge attributes for the file entry. In a Liferay repository, it may include:- fileEntryTypeId - ID for a custom file entry type
- fieldsMap - mapping for fields associated with a custom file entry type
- Returns:
- the file entry
- Throws:
PortalException
- if a portal exception occurredPortalException
-
updateFileEntry
public FileEntry updateFileEntry(long userId, long fileEntryId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, InputStream inputStream, long size, Date displayDate, Date expirationDate, Date reviewDate, ServiceContext serviceContext) throws PortalException Updates a file entry and associated metadata based on anInputStream
object. If the file data isnull
, then only the associated metadata (i.e.,title
,description
, and parameters in theserviceContext
) will be updated.This method takes two file names, the
sourceFileName
and thetitle
. ThesourceFileName
corresponds to the name of the actual file being uploaded. Thetitle
corresponds to a name the client wishes to assign this file after it has been uploaded to the portal.- Specified by:
updateFileEntry
in interfaceDLAppLocalService
- Parameters:
userId
- the primary key of the userfileEntryId
- the primary key of the file entrysourceFileName
- the original file's name (optionallynull
)mimeType
- the file's MIME type (optionallynull
)title
- the new name to be assigned to the file (optionallynull
description
- the file's new descriptionchangeLog
- the file's version change log (optionallynull
)dlVersionNumberIncrease
- the kind of version number increase to apply for these changes.inputStream
- the file's data (optionallynull
)size
- the file's size (optionally0
)displayDate
- the file's displaydate (optionallynull
)expirationDate
- the file's expiration date (optionallynull
)reviewDate
- the file's review date (optionallynull
)serviceContext
- the service context to be applied. Can set the asset category IDs, asset tag names, and expando bridge attributes for the file entry. In a Liferay repository, it may include:- fileEntryTypeId - ID for a custom file entry type
- fieldsMap - mapping for fields associated with a custom file entry type
- Returns:
- the file entry
- Throws:
PortalException
- if a portal exception occurredPortalException
-
updateFileShortcut
public FileShortcut updateFileShortcut(long userId, long fileShortcutId, long folderId, long toFileEntryId, ServiceContext serviceContext) throws PortalException Updates a file shortcut to the existing file entry. This method is only supported by the Liferay repository.- Specified by:
updateFileShortcut
in interfaceDLAppLocalService
- Parameters:
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.- Returns:
- the file shortcut
- Throws:
PortalException
- if a portal exception occurredPortalException
-
updateFileShortcuts
public void updateFileShortcuts(long oldToFileEntryId, long newToFileEntryId) throws PortalException Updates all file shortcuts to the existing file entry to the new file entry. This method is only supported by the Liferay repository.- Specified by:
updateFileShortcuts
in interfaceDLAppLocalService
- Parameters:
oldToFileEntryId
- the primary key of the old file entry pointed tonewToFileEntryId
- the primary key of the new file entry to point to- Throws:
PortalException
- if a portal exception occurredPortalException
-
updateFolder
public Folder updateFolder(long folderId, long parentFolderId, String name, String description, ServiceContext serviceContext) throws PortalException Updates the folder.- Specified by:
updateFolder
in interfaceDLAppLocalService
- Parameters:
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:- defaultFileEntryTypeId - the file entry type to default all Liferay file entries to
- dlFileEntryTypesSearchContainerPrimaryKeys - a comma-delimited list of file entry type primary keys allowed in the given folder and all descendants
- restrictionType - specifying restriction type of file entry types allowed
- workflowDefinitionXYZ - the workflow definition name
specified per file entry type. The parameter name must be the
string
workflowDefinition
appended by thefileEntryTypeId
(optionally0
).
- Returns:
- the folder
- Throws:
PortalException
- if a portal exception occurredPortalException
-
getWrappedService
- Specified by:
getWrappedService
in interfaceServiceWrapper<DLAppLocalService>
-
setWrappedService
- Specified by:
setWrappedService
in interfaceServiceWrapper<DLAppLocalService>
-
addFileEntry(String, long, long, long, String, String, String, String, String, String, File, Date, Date expirationDate, Date, ServiceContext)