Class DLAppLocalServiceWrapper

Object
com.liferay.document.library.kernel.service.DLAppLocalServiceWrapper
All Implemented Interfaces:
DLAppLocalService, BaseLocalService, ServiceWrapper<DLAppLocalService>

public class DLAppLocalServiceWrapper extends Object implements DLAppLocalService, ServiceWrapper<DLAppLocalService>
Provides a wrapper for DLAppLocalService.
Author:
Brian Wing Shun Chan
See Also:
{$generated.description}
  • Constructor Details

    • DLAppLocalServiceWrapper

      public DLAppLocalServiceWrapper()
    • DLAppLocalServiceWrapper

      public DLAppLocalServiceWrapper(DLAppLocalService dlAppLocalService)
  • 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
      Adds a file entry and associated metadata based on a 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.

      Specified by:
      addFileEntry in interface DLAppLocalService
      Parameters:
      userId - the primary key of the file entry's creator/owner
      repositoryId - the primary key of the repository
      folderId - the primary key of the file entry's parent folder
      sourceFileName - the original file's name
      mimeType - the file's MIME type
      title - the name to be assigned to the file (optionally null )
      description - the file's description
      changeLog - the file's version change log
      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:
      • 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 occurred
      PortalException
    • 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 interface DLAppLocalService
      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 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.

      Specified by:
      addFileEntry in interface DLAppLocalService
      Parameters:
      externalReferenceCode - the file entry's external reference code
      userId - the primary key of the file entry's creator/owner
      repositoryId - the primary key of the file entry's repository
      folderId - the primary key of the file entry's parent folder
      sourceFileName - the original file's name
      mimeType - the file's MIME type
      title - the name to be assigned to the file (optionally null )
      description - the file's description
      changeLog - the file's version change log
      bytes - the file's data (optionally null)
      displayDate - the file's display date (optionally null)
      expirationDate - the file's expiration date (optionally null )
      reviewDate - the file's review Date (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:
      • 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 occurred
      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, File file, Date displayDate, Date expirationDate, Date reviewDate, ServiceContext serviceContext) throws PortalException
      Adds a file entry and associated metadata based on a 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.

      Specified by:
      addFileEntry in interface DLAppLocalService
      Parameters:
      externalReferenceCode - the file entry's external reference code
      userId - the primary key of the file entry's creator/owner
      repositoryId - the primary key of the repository
      folderId - the primary key of the file entry's parent folder
      sourceFileName - the original file's name
      mimeType - the file's MIME type
      title - the name to be assigned to the file (optionally null )
      description - the file's description
      changeLog - the file's version change log
      file - the file's data (optionally null)
      displayDate - the file's display date (optionally null)
      expirationDate - the file's expiration date (optionally null)
      reviewDate - the file's review Date (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:
      • 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 occurred
      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, InputStream inputStream, long size, Date displayDate, Date expirationDate, Date reviewDate, ServiceContext serviceContext) throws PortalException
      Adds a file entry and associated metadata based on an 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.

      Specified by:
      addFileEntry in interface DLAppLocalService
      Parameters:
      externalReferenceCode - the file entry's external reference code
      userId - the primary key of the file entry's creator/owner
      repositoryId - the primary key of the repository
      folderId - the primary key of the file entry's parent folder
      sourceFileName - the original file's name
      mimeType - the file's MIME type
      title - the name to be assigned to the file (optionally null )
      description - the file's description
      changeLog - the file's version change log
      inputStream - the file's data (optionally null)
      size - the file's size (optionally 0)
      displayDate - the file's display date (optionally null)
      expirationDate - the file's expiration date (optionally null )
      reviewDate - the file's review Date (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:
      • 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 occurred
      PortalException
    • 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 interface DLAppLocalService
      Parameters:
      userId - the primary key of the file shortcut's creator/owner
      repositoryId - the primary key of the repository
      folderId - the primary key of the file shortcut's parent folder
      toFileEntryId - the primary key of the file entry to point to
      serviceContext - 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 occurred
      PortalException
    • 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 interface DLAppLocalService
      Parameters:
      userId - the primary key of the folder's creator/owner
      repositoryId - the primary key of the repository
      parentFolderId - the primary key of the folder's parent folder
      name - the folder's name
      description - the folder's description
      serviceContext - 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 occurred
      PortalException
    • deleteAll

      public void deleteAll(long repositoryId) throws PortalException
      Delete all data associated to the given repository. This method is only supported by the Liferay repository.
      Specified by:
      deleteAll in interface DLAppLocalService
      Parameters:
      repositoryId - the primary key of the data's repository
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • deleteAllRepositories

      public void deleteAllRepositories(long groupId) throws PortalException
      Specified by:
      deleteAllRepositories in interface DLAppLocalService
      Throws:
      PortalException
    • deleteFileEntry

      public void deleteFileEntry(long fileEntryId) throws PortalException
      Deletes the file entry.
      Specified by:
      deleteFileEntry in interface DLAppLocalService
      Parameters:
      fileEntryId - the primary key of the file entry
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • deleteFileEntryByExternalReferenceCode

      public void deleteFileEntryByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException
      Specified by:
      deleteFileEntryByExternalReferenceCode in interface DLAppLocalService
      Throws:
      PortalException
    • deleteFileShortcut

      public void deleteFileShortcut(FileShortcut fileShortcut) throws PortalException
      Deletes the file shortcut. This method is only supported by the Liferay repository.
      Specified by:
      deleteFileShortcut in interface DLAppLocalService
      Parameters:
      fileShortcut - the file shortcut
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • deleteFileShortcut

      public void deleteFileShortcut(long fileShortcutId) throws PortalException
      Deletes the file shortcut. This method is only supported by the Liferay repository.
      Specified by:
      deleteFileShortcut in interface DLAppLocalService
      Parameters:
      fileShortcutId - the primary key of the file shortcut
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • deleteFileShortcuts

      public void deleteFileShortcuts(long toFileEntryId) throws PortalException
      Deletes all file shortcuts associated to the file entry. This method is only supported by the Liferay repository.
      Specified by:
      deleteFileShortcuts in interface DLAppLocalService
      Parameters:
      toFileEntryId - the primary key of the associated file entry
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • deleteFileVersion

      public void deleteFileVersion(long fileVersionId) throws PortalException
      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 interface DLAppLocalService
      Parameters:
      fileVersionId - the primary key of the file version
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • deleteFolder

      public void deleteFolder(long folderId) throws PortalException
      Deletes the folder and all of its subfolders and file entries.
      Specified by:
      deleteFolder in interface DLAppLocalService
      Parameters:
      folderId - the primary key of the folder
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • 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 interface DLAppLocalService
      Parameters:
      groupId - the primary key of the file entry's group
      externalReferenceCode - 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

      public FileShortcut fetchFileShortcut(long fileShortcutId) throws PortalException
      Specified by:
      fetchFileShortcut in interface DLAppLocalService
      Throws:
      PortalException
    • fetchFileShortcutByExternalReferenceCode

      public FileShortcut fetchFileShortcutByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException
      Specified by:
      fetchFileShortcutByExternalReferenceCode in interface DLAppLocalService
      Throws:
      PortalException
    • fetchFolderByExternalReferenceCode

      public Folder fetchFolderByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException
      Specified by:
      fetchFolderByExternalReferenceCode in interface DLAppLocalService
      Throws:
      PortalException
    • getFileEntry

      public FileEntry getFileEntry(long fileEntryId) throws PortalException
      Returns the file entry with the primary key.
      Specified by:
      getFileEntry in interface DLAppLocalService
      Parameters:
      fileEntryId - the primary key of the file entry
      Returns:
      the file entry with the primary key
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • getFileEntry

      public FileEntry getFileEntry(long groupId, long folderId, String title) throws PortalException
      Returns the file entry with the title in the folder.
      Specified by:
      getFileEntry in interface DLAppLocalService
      Parameters:
      groupId - the primary key of the file entry's group
      folderId - the primary key of the file entry's folder
      title - the file entry's title
      Returns:
      the file entry with the title in the folder
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • getFileEntryByExternalReferenceCode

      public FileEntry getFileEntryByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException
      Returns the file entry with the external reference code.
      Specified by:
      getFileEntryByExternalReferenceCode in interface DLAppLocalService
      Parameters:
      groupId - the primary key of the file entry's group
      externalReferenceCode - the file entry's external reference code
      Returns:
      the file entry with the external reference code
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • 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 interface DLAppLocalService
      Parameters:
      groupId - the primary key of the file entry's group
      folderId - the primary key of the file entry's folder
      fileName - the file entry's file name
      Returns:
      the file entry with the file name in the folder
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • getFileEntryByUuidAndGroupId

      public FileEntry getFileEntryByUuidAndGroupId(String uuid, long groupId) throws PortalException
      Returns the file entry with the UUID and group.
      Specified by:
      getFileEntryByUuidAndGroupId in interface DLAppLocalService
      Parameters:
      uuid - the file entry's UUID
      groupId - the primary key of the file entry's group
      Returns:
      the file entry with the UUID and group
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • getFileShortcut

      public FileShortcut getFileShortcut(long fileShortcutId) throws PortalException
      Returns the file shortcut with the primary key. This method is only supported by the Liferay repository.
      Specified by:
      getFileShortcut in interface DLAppLocalService
      Parameters:
      fileShortcutId - the primary key of the file shortcut
      Returns:
      the file shortcut with the primary key
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • getFileShortcutByExternalReferenceCode

      public FileShortcut getFileShortcutByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException
      Specified by:
      getFileShortcutByExternalReferenceCode in interface DLAppLocalService
      Throws:
      PortalException
    • getFileVersion

      public FileVersion getFileVersion(long fileVersionId) throws PortalException
      Returns the file version with the primary key.
      Specified by:
      getFileVersion in interface DLAppLocalService
      Parameters:
      fileVersionId - the primary key of the file version
      Returns:
      the file version with the primary key
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • getFolder

      public Folder getFolder(long folderId) throws PortalException
      Returns the folder with the primary key.
      Specified by:
      getFolder in interface DLAppLocalService
      Parameters:
      folderId - the primary key of the folder
      Returns:
      the folder with the primary key
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • getFolder

      public Folder getFolder(long repositoryId, long parentFolderId, String name) throws PortalException
      Returns the folder with the name in the parent folder.
      Specified by:
      getFolder in interface DLAppLocalService
      Parameters:
      repositoryId - the primary key of the folder's repository
      parentFolderId - the primary key of the folder's parent folder
      name - the folder's name
      Returns:
      the folder with the name in the parent folder
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • getFolderByExternalReferenceCode

      public Folder getFolderByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException
      Specified by:
      getFolderByExternalReferenceCode in interface DLAppLocalService
      Throws:
      PortalException
    • getMountFolder

      public Folder getMountFolder(long repositoryId) throws PortalException
      Returns the mount folder of the repository with the primary key. This method is only supported by the Liferay repository.
      Specified by:
      getMountFolder in interface DLAppLocalService
      Parameters:
      repositoryId - the primary key of the repository
      Returns:
      the folder used for mounting third-party repositories
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • getOSGiServiceIdentifier

      public String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Specified by:
      getOSGiServiceIdentifier in interface DLAppLocalService
      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 interface DLAppLocalService
      Parameters:
      userId - the primary key of the user
      fileEntryId - the primary key of the file entry
      newFolderId - the primary key of the new folder
      serviceContext - the service context to be applied
      Returns:
      the file entry
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • moveFolder

      public Folder moveFolder(long userId, long folderId, long parentFolderId, ServiceContext serviceContext) throws PortalException
      Specified by:
      moveFolder in interface DLAppLocalService
      Throws:
      PortalException
    • subscribeFileEntry

      public void subscribeFileEntry(long userId, long groupId, long fileEntryId) throws PortalException
      Specified by:
      subscribeFileEntry in interface DLAppLocalService
      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 interface DLAppLocalService
      Parameters:
      userId - the primary key of the user
      groupId - the primary key of the file entry type's group
      fileEntryTypeId - the primary key of the file entry type
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • subscribeFolder

      public void subscribeFolder(long userId, long groupId, long folderId) throws PortalException
      Subscribe the user to document changes in the folder. This method is only supported by the Liferay repository.
      Specified by:
      subscribeFolder in interface DLAppLocalService
      Parameters:
      userId - the primary key of the user
      groupId - the primary key of the folder's group
      folderId - the primary key of the folder
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • unsubscribeFileEntry

      public void unsubscribeFileEntry(long userId, long groupId, long fileEntryId) throws PortalException
      Specified by:
      unsubscribeFileEntry in interface DLAppLocalService
      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 interface DLAppLocalService
      Parameters:
      userId - the primary key of the user
      groupId - the primary key of the file entry type's group
      fileEntryTypeId - the primary key of the file entry type
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • unsubscribeFolder

      public void unsubscribeFolder(long userId, long groupId, long folderId) throws PortalException
      Unsubscribe the user from document changes in the folder. This method is only supported by the Liferay repository.
      Specified by:
      unsubscribeFolder in interface DLAppLocalService
      Parameters:
      userId - the primary key of the user
      groupId - the primary key of the folder's group
      folderId - the primary key of the folder
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • 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 interface DLAppLocalService
      Parameters:
      userId - the primary key of the user
      fileEntry - the file entry to update
      fileVersion - the file version to update
      assetCategoryIds - the primary keys of the new asset categories
      assetTagNames - the new asset tag names
      assetLinkEntryIds - the primary keys of the new asset link entries
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • 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 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.

      Specified by:
      updateFileEntry in interface DLAppLocalService
      Parameters:
      userId - the primary key of the user
      fileEntryId - the primary key of the file entry
      sourceFileName - 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 description
      changeLog - 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)
      displayDate - the file's display date (optionally null )
      expirationDate - the file's expiration date (optionally null )
      reviewDate - the file's review date (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:
      • 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 occurred
      PortalException
    • 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 a 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.

      Specified by:
      updateFileEntry in interface DLAppLocalService
      Parameters:
      userId - the primary key of the user
      fileEntryId - the primary key of the file entry
      sourceFileName - 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 description
      changeLog - 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)
      displayDate - the file's display date (optionally null )
      expirationDate - the file's expiration date (optionally null )
      reviewDate - the file's review date (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:
      • 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 occurred
      PortalException
    • 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 an 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.

      Specified by:
      updateFileEntry in interface DLAppLocalService
      Parameters:
      userId - the primary key of the user
      fileEntryId - the primary key of the file entry
      sourceFileName - 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 description
      changeLog - 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)
      displayDate - the file's displaydate (optionally null )
      expirationDate - the file's expiration date (optionally null )
      reviewDate - the file's review date (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:
      • 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 occurred
      PortalException
    • 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 interface DLAppLocalService
      Parameters:
      userId - the primary key of the file shortcut's creator/owner
      fileShortcutId - the primary key of the file shortcut
      folderId - the primary key of the file shortcut's parent folder
      toFileEntryId - the primary key of the file shortcut's file entry
      serviceContext - 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 occurred
      PortalException
    • 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 interface DLAppLocalService
      Parameters:
      oldToFileEntryId - the primary key of the old file entry pointed to
      newToFileEntryId - the primary key of the new file entry to point to
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • updateFolder

      public Folder updateFolder(long folderId, long parentFolderId, String name, String description, ServiceContext serviceContext) throws PortalException
      Updates the folder.
      Specified by:
      updateFolder in interface DLAppLocalService
      Parameters:
      folderId - the primary key of the folder
      parentFolderId - the primary key of the folder's new parent folder
      name - the folder's new name
      description - the folder's new description
      serviceContext - 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 the fileEntryTypeId (optionally 0).
      Returns:
      the folder
      Throws:
      PortalException - if a portal exception occurred
      PortalException
    • getWrappedService

      public DLAppLocalService getWrappedService()
      Specified by:
      getWrappedService in interface ServiceWrapper<DLAppLocalService>
    • setWrappedService

      public void setWrappedService(DLAppLocalService dlAppLocalService)
      Specified by:
      setWrappedService in interface ServiceWrapper<DLAppLocalService>