DLAppLocalServiceWrapper (Liferay 7.1.10 portal-kernel API)

Object
- com.liferay.document.library.kernel.service.DLAppLocalServiceWrapper

All Implemented Interfaces:

DLAppLocalService, BaseLocalService, ServiceWrapper<DLAppLocalService>
```
@ProviderType
public class DLAppLocalServiceWrapper
extends Object
implements DLAppLocalService, ServiceWrapper<DLAppLocalService>
```
Provides a wrapper for DLAppLocalService.

Author:

Brian Wing Shun Chan

See Also:

DLAppLocalService

{$generated.description}

Constructor Summary

Constructors
Constructor and Description

DLAppLocalServiceWrapper(DLAppLocalService dlAppLocalService)

Constructors
Constructor and Description
`DLAppLocalServiceWrapper(DLAppLocalService dlAppLocalService)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
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 is, long size, ServiceContext serviceContext)` Adds a file entry and associated metadata based on an `InputStream` object.
`com.liferay.document.library.kernel.model.DLFileRank`	`addFileRank(long repositoryId, long companyId, long userId, long fileEntryId, ServiceContext serviceContext)` Deprecated. As of Judson (7.1.x), replaced by `com.liferay.document.library.file.rank.service.DLFileRankLocalService#addFileRank`
`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`	`deleteFileRanksByFileEntryId(long fileEntryId)` Deprecated. As of Judson (7.1.x), replaced by `com.liferay.document.library.file.rank.service.DLFileRankLocalService#deleteFileRanksByFileEntryId`
`void`	`deleteFileRanksByUserId(long userId)` Deprecated. As of Judson (7.1.x), replaced by `com.liferay.document.library.file.rank.service.DLFileRankLocalService#deleteFileRanksByUserId`
`void`	`deleteFileShortcut(FileShortcut fileShortcut)` Deletes the file shortcut.
`void`	`deleteFileShortcut(long fileShortcutId)` Deletes the file shortcut.
`void`	`deleteFileShortcuts(long toFileEntryId)` Deletes all file shortcuts associated to the file entry.
`void`	`deleteFolder(long folderId)` Deletes the folder and all of its subfolders and file entries.
`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.
`List<com.liferay.document.library.kernel.model.DLFileRank>`	`getFileRanks(long repositoryId, long userId)` Deprecated. As of Judson (7.1.x), replaced by `com.liferay.document.library.file.rank.service.DLFileRankLocalService#getFileRanks`
`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.
`DLAppLocalService`	`getWrappedService()`
`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`	`setWrappedService(DLAppLocalService dlAppLocalService)`
`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, boolean majorVersion, byte[] bytes, ServiceContext serviceContext)` Updates a file entry and associated metadata based on a byte array object.
`FileEntry`	`updateFileEntry(long userId, long fileEntryId, String sourceFileName, String mimeType, String title, String description, String changeLog, boolean majorVersion, 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, boolean majorVersion, InputStream is, long size, ServiceContext serviceContext)` Updates a file entry and associated metadata based on an `InputStream` object.
`com.liferay.document.library.kernel.model.DLFileRank`	`updateFileRank(long repositoryId, long companyId, long userId, long fileEntryId, ServiceContext serviceContext)` Deprecated. As of Judson (7.1.x), replaced by `com.liferay.document.library.file.rank.service.DLFileRankLocalService#updateFileRank`
`FileShortcut`	`updateFileShortcut(long userId, long fileShortcutId, long folderId, long toFileEntryId, ServiceContext serviceContext)` Updates a file shortcut to the existing file entry.
`void`	`updateFileShortcuts(long oldToFileEntryId, long newToFileEntryId)` Updates all file shortcuts to the existing file entry to the new file entry.
`void`	`updateFileShortcuts(long toRepositoryId, long oldToFileEntryId, long newToFileEntryId)` Deprecated. As of Wilberforce (7.0.x), replaced by `updateFileShortcuts(long, long)`
`Folder`	`updateFolder(long folderId, long parentFolderId, String name, String description, ServiceContext serviceContext)` Updates the folder.

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DLAppLocalServiceWrapper
```
public DLAppLocalServiceWrapper(DLAppLocalService dlAppLocalService)
```
- Method Detail
  - addFileEntry
```
public FileEntry addFileEntry(long userId,
                              long repositoryId,
                              long folderId,
                              String sourceFileName,
                              String mimeType,
                              byte[] bytes,
                              ServiceContext serviceContext)
                       throws PortalException
```
    Specified by:
    
    addFileEntry in interface DLAppLocalService
    
    Throws:
    
    PortalException
  - addFileEntry
```
public FileEntry addFileEntry(long userId,
                              long repositoryId,
                              long folderId,
                              String sourceFileName,
                              String mimeType,
                              String title,
                              String description,
                              String changeLog,
                              byte[] bytes,
                              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:
    
    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)
    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
  - addFileEntry
```
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
  - addFileEntry
```
public FileEntry addFileEntry(long userId,
                              long repositoryId,
                              long folderId,
                              String sourceFileName,
                              String mimeType,
                              String title,
                              String description,
                              String changeLog,
                              InputStream is,
                              long size,
                              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:
    
    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
    
    is - 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:
    
    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
  - addFileRank
```
@Deprecated
public com.liferay.document.library.kernel.model.DLFileRank addFileRank(long repositoryId,
                                                                                    long companyId,
                                                                                    long userId,
                                                                                    long fileEntryId,
                                                                                    ServiceContext serviceContext)
```
    Deprecated. As of Judson (7.1.x), replaced by com.liferay.document.library.file.rank.service.DLFileRankLocalService#addFileRank
    
    Adds the file rank to the existing file entry. This method is only supported by the Liferay repository.
    
    Specified by:
    
    addFileRank in interface DLAppLocalService
    
    Parameters:
    
    repositoryId - the primary key of the repository
    
    companyId - the primary key of the company
    
    userId - the primary key of the file rank's creator/owner
    
    fileEntryId - the primary key of the file entry
    
    serviceContext - the service context to be applied
    
    Returns:
    
    the file rank
  - addFileShortcut
```
public FileShortcut addFileShortcut(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
  - addFolder
```
public Folder addFolder(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
  - 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
  - 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
  - deleteFileRanksByFileEntryId
```
@Deprecated
public void deleteFileRanksByFileEntryId(long fileEntryId)
```
    Deprecated. As of Judson (7.1.x), replaced by com.liferay.document.library.file.rank.service.DLFileRankLocalService#deleteFileRanksByFileEntryId
    
    Deletes the file ranks associated to a given file entry. This method is only supported by the Liferay repository.
    
    Specified by:
    
    deleteFileRanksByFileEntryId in interface DLAppLocalService
    
    Parameters:
    
    fileEntryId - the primary key of the file entry
  - deleteFileRanksByUserId
```
@Deprecated
public void deleteFileRanksByUserId(long userId)
```
    Deprecated. As of Judson (7.1.x), replaced by com.liferay.document.library.file.rank.service.DLFileRankLocalService#deleteFileRanksByUserId
    
    Deletes the file ranks associated to a given user. This method is only supported by the Liferay repository.
    
    Specified by:
    
    deleteFileRanksByUserId in interface DLAppLocalService
    
    Parameters:
    
    userId - the primary key of the user
  - 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
  - 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
  - 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
  - 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
  - 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
  - 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
  - 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
  - getFileRanks
```
@Deprecated
public List<com.liferay.document.library.kernel.model.DLFileRank> getFileRanks(long repositoryId,
                                                                                           long userId)
```
    Deprecated. As of Judson (7.1.x), replaced by com.liferay.document.library.file.rank.service.DLFileRankLocalService#getFileRanks
    
    Returns the file ranks from the user. This method is only supported by the Liferay repository.
    
    Specified by:
    
    getFileRanks in interface DLAppLocalService
    
    Parameters:
    
    repositoryId - the primary key of the repository
    
    userId - the primary key of the user
    
    Returns:
    
    the file ranks from the user
  - 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
  - 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
  - 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
  - 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
  - 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
  - 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
  - moveFolder
```
public Folder moveFolder(long userId,
                         long folderId,
                         long parentFolderId,
                         ServiceContext serviceContext)
                  throws PortalException
```
    Specified by:
    
    moveFolder 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
  - 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
  - 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
  - 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
  - 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
  - updateFileEntry
```
public FileEntry updateFileEntry(long userId,
                                 long fileEntryId,
                                 String sourceFileName,
                                 String mimeType,
                                 String title,
                                 String description,
                                 String changeLog,
                                 boolean majorVersion,
                                 byte[] bytes,
                                 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)
    
    majorVersion - whether the new file version is a major version
    
    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:
    
    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
  - updateFileEntry
```
public FileEntry updateFileEntry(long userId,
                                 long fileEntryId,
                                 String sourceFileName,
                                 String mimeType,
                                 String title,
                                 String description,
                                 String changeLog,
                                 boolean majorVersion,
                                 File file,
                                 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)
    
    majorVersion - whether the new file version is a major version
    
    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
  - updateFileEntry
```
public FileEntry updateFileEntry(long userId,
                                 long fileEntryId,
                                 String sourceFileName,
                                 String mimeType,
                                 String title,
                                 String description,
                                 String changeLog,
                                 boolean majorVersion,
                                 InputStream is,
                                 long size,
                                 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)
    
    majorVersion - whether the new file version is a major version
    
    is - 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:
    
    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
  - updateFileRank
```
@Deprecated
public com.liferay.document.library.kernel.model.DLFileRank updateFileRank(long repositoryId,
                                                                                       long companyId,
                                                                                       long userId,
                                                                                       long fileEntryId,
                                                                                       ServiceContext serviceContext)
```
    Deprecated. As of Judson (7.1.x), replaced by com.liferay.document.library.file.rank.service.DLFileRankLocalService#updateFileRank
    
    Updates a file rank to the existing file entry. This method is only supported by the Liferay repository.
    
    Specified by:
    
    updateFileRank in interface DLAppLocalService
    
    Parameters:
    
    repositoryId - the primary key of the file rank's repository
    
    companyId - the primary key of the file rank's company
    
    userId - the primary key of the file rank's creator/owner
    
    fileEntryId - the primary key of the file rank's file entry
    
    serviceContext - the service context to be applied
    
    Returns:
    
    the file rank
  - 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
  - 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
  - updateFileShortcuts
```
@Deprecated
public void updateFileShortcuts(long toRepositoryId,
                                            long oldToFileEntryId,
                                            long newToFileEntryId)
                                     throws PortalException
```
    Deprecated. As of Wilberforce (7.0.x), replaced by updateFileShortcuts(long, long)
    
    Specified by:
    
    updateFileShortcuts in interface DLAppLocalService
    
    Throws:
    
    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
  - getWrappedService
```
public DLAppLocalService getWrappedService()
```
    Specified by:
    
    getWrappedService in interface ServiceWrapper<DLAppLocalService>
  - setWrappedService
```
public void setWrappedService(DLAppLocalService dlAppLocalService)
```
    Specified by:
    
    setWrappedService in interface ServiceWrapper<DLAppLocalService>

Class DLAppLocalServiceWrapper

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

DLAppLocalServiceWrapper

Method Detail

addFileEntry

addFileEntry

addFileEntry

addFileEntry

addFileRank

addFileShortcut

addFolder

deleteAll

deleteAllRepositories

deleteFileEntry

deleteFileRanksByFileEntryId

deleteFileRanksByUserId

deleteFileShortcut

deleteFileShortcut

deleteFileShortcuts

deleteFolder

getFileEntry

getFileEntry

getFileEntryByUuidAndGroupId

getFileRanks

getFileShortcut

getFileVersion

getFolder

getFolder

getMountFolder

getOSGiServiceIdentifier

moveFileEntry

moveFolder

subscribeFileEntryType

subscribeFolder

unsubscribeFileEntryType

unsubscribeFolder

updateAsset

updateFileEntry

updateFileEntry

updateFileEntry

updateFileRank

updateFileShortcut

updateFileShortcuts

updateFileShortcuts

updateFolder

getWrappedService

setWrappedService