com.liferay.portlet.documentlibrary.service.impl

Class DLAppLocalServiceImpl

Object

com.liferay.portal.kernel.service.BaseLocalServiceImpl

com.liferay.portlet.documentlibrary.service.base.DLAppLocalServiceBaseImpl

com.liferay.portlet.documentlibrary.service.impl.DLAppLocalServiceImpl

All Implemented Interfaces:

com.liferay.document.library.kernel.service.DLAppLocalService, com.liferay.portal.kernel.module.framework.service.IdentifiableOSGiService, com.liferay.portal.kernel.service.BaseLocalService

public class DLAppLocalServiceImpl
extends DLAppLocalServiceBaseImpl

Provides the local service for accessing, adding, deleting, moving, subscription handling of, and updating document library file entries, file ranks, and folders. All portlets should interact with the document library through this class or through DLAppService, rather than through the individual document library service classes.

This class provides a unified interface to all Liferay and third party repositories. While the method signatures are universal for all repositories. Additional implementation-specific parameters may be specified in the serviceContext.

The repositoryId parameter used by most of the methods is the primary key of the specific repository. If the repository is a default Liferay repository, the repositoryId is the groupId or scopeGroupId. Otherwise, the repositoryId will correspond to values obtained from RepositoryLocalServiceUtil.

Author:

Alexander Chow, Mika Koivisto

See Also:

DLAppServiceImpl

Field Summary

Fields

Modifier and Type	Field and Description
protected com.liferay.portal.kernel.repository.RepositoryProvider	repositoryProvider

Fields inherited from class com.liferay.portlet.documentlibrary.service.base.DLAppLocalServiceBaseImpl

counterLocalService, dlAppLocalService

Constructor Summary

Constructors

Constructor and Description
DLAppLocalServiceImpl()

Method Summary

Modifier and Type	Method and Description
com.liferay.portal.kernel.repository.model.FileEntry	addFileEntry(long userId, long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String description, String changeLog, File file, com.liferay.portal.kernel.service.ServiceContext serviceContext) Deprecated. As of Cavanaugh (7.4.x), replaced by #addFileEntry(String, long, long, long, String, String, String, String, String, File, Date, Date, ServiceContext)
com.liferay.portal.kernel.repository.model.FileEntry	addFileEntry(String externalReferenceCode, long userId, long repositoryId, long folderId, String sourceFileName, String mimeType, byte[] bytes, Date expirationDate, Date reviewDate, com.liferay.portal.kernel.service.ServiceContext serviceContext)
com.liferay.portal.kernel.repository.model.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 expirationDate, Date reviewDate, com.liferay.portal.kernel.service.ServiceContext serviceContext) Adds a file entry and associated metadata based on a byte array.
com.liferay.portal.kernel.repository.model.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 expirationDate, Date reviewDate, com.liferay.portal.kernel.service.ServiceContext serviceContext) Adds a file entry and associated metadata based on a File object.
com.liferay.portal.kernel.repository.model.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 expirationDate, Date reviewDate, com.liferay.portal.kernel.service.ServiceContext serviceContext) Adds a file entry and associated metadata based on an InputStream object.
com.liferay.portal.kernel.repository.model.FileShortcut	addFileShortcut(long userId, long repositoryId, long folderId, long toFileEntryId, com.liferay.portal.kernel.service.ServiceContext serviceContext) Adds the file shortcut to the existing file entry.
com.liferay.portal.kernel.repository.model.Folder	addFolder(long userId, long repositoryId, long parentFolderId, String name, String description, com.liferay.portal.kernel.service.ServiceContext serviceContext) Adds a folder.
protected com.liferay.portal.kernel.repository.model.FileEntry	copyFileEntry(long userId, com.liferay.portal.kernel.repository.LocalRepository toLocalRepository, com.liferay.portal.kernel.repository.model.FileEntry fileEntry, long newFolderId, com.liferay.portal.kernel.service.ServiceContext serviceContext)
protected com.liferay.portal.kernel.repository.model.Folder	copyFolder(long userId, long folderId, long parentFolderId, com.liferay.portal.kernel.repository.LocalRepository fromLocalRepository, com.liferay.portal.kernel.repository.LocalRepository toLocalRepository, com.liferay.portal.kernel.service.ServiceContext serviceContext)
protected void	copyFolderDependencies(long userId, com.liferay.portal.kernel.repository.model.Folder sourceFolder, com.liferay.portal.kernel.repository.model.Folder destinationFolder, com.liferay.portal.kernel.repository.LocalRepository fromLocalRepository, com.liferay.portal.kernel.repository.LocalRepository toLocalRepository, com.liferay.portal.kernel.service.ServiceContext serviceContext)
void	deleteAll(long repositoryId) Delete all data associated to the given repository.
void	deleteAllRepositories(long groupId)
void	deleteFileEntry(long fileEntryId) Deletes the file entry.
protected void	deleteFileEntry(long oldFileEntryId, long newFileEntryId, com.liferay.portal.kernel.repository.LocalRepository fromLocalRepository, com.liferay.portal.kernel.repository.LocalRepository toLocalRepository)
void	deleteFileShortcut(com.liferay.portal.kernel.repository.model.FileShortcut fileShortcut) Deletes the file shortcut.
void	deleteFileShortcut(long fileShortcutId) Deletes the file shortcut.
void	deleteFileShortcuts(long toFileEntryId) Deletes all file shortcuts associated to the file entry.
void	deleteFileVersion(long fileVersionId) Deletes the file version.
void	deleteFolder(long folderId) Deletes the folder and all of its subfolders and file entries.
protected void	deleteRepository(com.liferay.portal.kernel.repository.LocalRepository localRepository)
com.liferay.portal.kernel.repository.model.FileEntry	fetchFileEntryByExternalReferenceCode(long groupId, String externalReferenceCode) Returns the document library file entry with the matching external reference code and group.
com.liferay.portal.kernel.repository.model.FileEntry	getFileEntry(long fileEntryId) Returns the file entry with the primary key.
com.liferay.portal.kernel.repository.model.FileEntry	getFileEntry(long groupId, long folderId, String title) Returns the file entry with the title in the folder.
com.liferay.portal.kernel.repository.model.FileEntry	getFileEntryByExternalReferenceCode(long groupId, String externalReferenceCode) Returns the file entry with the external reference code.
com.liferay.portal.kernel.repository.model.FileEntry	getFileEntryByFileName(long groupId, long folderId, String fileName) Returns the file entry with the file name in the folder.
com.liferay.portal.kernel.repository.model.FileEntry	getFileEntryByUuidAndGroupId(String uuid, long groupId) Returns the file entry with the UUID and group.
com.liferay.portal.kernel.repository.model.FileShortcut	getFileShortcut(long fileShortcutId) Returns the file shortcut with the primary key.
com.liferay.portal.kernel.repository.model.FileVersion	getFileVersion(long fileVersionId) Returns the file version with the primary key.
com.liferay.portal.kernel.repository.model.Folder	getFolder(long folderId) Returns the folder with the primary key.
com.liferay.portal.kernel.repository.model.Folder	getFolder(long repositoryId, long parentFolderId, String name) Returns the folder with the name in the parent folder.
protected com.liferay.portal.kernel.repository.LocalRepository	getFolderLocalRepository(long folderId, long groupId)
protected com.liferay.portal.kernel.repository.LocalRepository	getLocalRepository(long repositoryId)
com.liferay.portal.kernel.repository.model.Folder	getMountFolder(long repositoryId) Returns the mount folder of the repository with the primary key.
protected com.liferay.portal.kernel.repository.model.FileEntry	moveFileEntry(long userId, long fileEntryId, long newFolderId, com.liferay.portal.kernel.repository.LocalRepository fromLocalRepository, com.liferay.portal.kernel.repository.LocalRepository toLocalRepository, com.liferay.portal.kernel.service.ServiceContext serviceContext)
com.liferay.portal.kernel.repository.model.FileEntry	moveFileEntry(long userId, long fileEntryId, long newFolderId, com.liferay.portal.kernel.service.ServiceContext serviceContext) Moves the file entry to the new folder.
protected com.liferay.portal.kernel.repository.model.Folder	moveFolder(long userId, long folderId, long parentFolderId, com.liferay.portal.kernel.repository.LocalRepository fromLocalRepository, com.liferay.portal.kernel.repository.LocalRepository toLocalRepository, com.liferay.portal.kernel.service.ServiceContext serviceContext)
com.liferay.portal.kernel.repository.model.Folder	moveFolder(long userId, long folderId, long parentFolderId, com.liferay.portal.kernel.service.ServiceContext serviceContext)
void	subscribeFileEntryType(long userId, long groupId, long fileEntryTypeId) Subscribe the user to changes in documents of the file entry type.
void	subscribeFolder(long userId, long groupId, long folderId) Subscribe the user to document changes in the folder.
void	unsubscribeFileEntryType(long userId, long groupId, long fileEntryTypeId) Unsubscribe the user from changes in documents of the file entry type.
void	unsubscribeFolder(long userId, long groupId, long folderId) Unsubscribe the user from document changes in the folder.
void	updateAsset(long userId, com.liferay.portal.kernel.repository.model.FileEntry fileEntry, com.liferay.portal.kernel.repository.model.FileVersion fileVersion, long[] assetCategoryIds, String[] assetTagNames, long[] assetLinkEntryIds) Updates the file entry's asset replacing its asset categories, tags, and links.
com.liferay.portal.kernel.repository.model.FileEntry	updateFileEntry(long userId, long fileEntryId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, com.liferay.document.library.kernel.model.DLVersionNumberIncrease dlVersionNumberIncrease, byte[] bytes, Date expirationDate, Date reviewDate, com.liferay.portal.kernel.service.ServiceContext serviceContext) Updates a file entry and associated metadata based on a byte array object.
com.liferay.portal.kernel.repository.model.FileEntry	updateFileEntry(long userId, long fileEntryId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, com.liferay.document.library.kernel.model.DLVersionNumberIncrease dlVersionNumberIncrease, File file, Date expirationDate, Date reviewDate, com.liferay.portal.kernel.service.ServiceContext serviceContext) Updates a file entry and associated metadata based on a File object.
com.liferay.portal.kernel.repository.model.FileEntry	updateFileEntry(long userId, long fileEntryId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, com.liferay.document.library.kernel.model.DLVersionNumberIncrease dlVersionNumberIncrease, InputStream inputStream, long size, Date expirationDate, Date reviewDate, com.liferay.portal.kernel.service.ServiceContext serviceContext) Updates a file entry and associated metadata based on an InputStream object.
com.liferay.portal.kernel.repository.model.FileShortcut	updateFileShortcut(long userId, long fileShortcutId, long folderId, long toFileEntryId, com.liferay.portal.kernel.service.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.
com.liferay.portal.kernel.repository.model.Folder	updateFolder(long folderId, long parentFolderId, String name, String description, com.liferay.portal.kernel.service.ServiceContext serviceContext) Updates the folder.

Methods inherited from class com.liferay.portlet.documentlibrary.service.base.DLAppLocalServiceBaseImpl

afterPropertiesSet, destroy, getCounterLocalService, getDLAppLocalService, getOSGiServiceIdentifier, runSQL, setCounterLocalService, setDLAppLocalService

Methods inherited from class com.liferay.portal.kernel.service.BaseLocalServiceImpl

getClassLoader, getLocalizationMap

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

repositoryProvider

@BeanReference(type=com.liferay.portal.kernel.repository.RepositoryProvider.class)
protected com.liferay.portal.kernel.repository.RepositoryProvider repositoryProvider

Constructor Detail

DLAppLocalServiceImpl

public DLAppLocalServiceImpl()

Method Detail

addFileEntry

@Deprecated
public com.liferay.portal.kernel.repository.model.FileEntry addFileEntry(long userId,
                                                                                     long repositoryId,
                                                                                     long folderId,
                                                                                     String sourceFileName,
                                                                                     String mimeType,
                                                                                     String title,
                                                                                     String description,
                                                                                     String changeLog,
                                                                                     File file,
                                                                                     com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                                              throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of Cavanaugh (7.4.x), replaced by #addFileEntry(String, long, long, long, String, String, String, String, String, File, Date, Date, ServiceContext)

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.

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:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

addFileEntry

public com.liferay.portal.kernel.repository.model.FileEntry addFileEntry(String externalReferenceCode,
                                                                         long userId,
                                                                         long repositoryId,
                                                                         long folderId,
                                                                         String sourceFileName,
                                                                         String mimeType,
                                                                         byte[] bytes,
                                                                         Date expirationDate,
                                                                         Date reviewDate,
                                                                         com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                                  throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addFileEntry

public com.liferay.portal.kernel.repository.model.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 expirationDate,
                                                                         Date reviewDate,
                                                                         com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                                  throws com.liferay.portal.kernel.exception.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.

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)

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:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

addFileEntry

public com.liferay.portal.kernel.repository.model.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 expirationDate,
                                                                         Date reviewDate,
                                                                         com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                                  throws com.liferay.portal.kernel.exception.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.

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)

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:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

addFileEntry

public com.liferay.portal.kernel.repository.model.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 expirationDate,
                                                                         Date reviewDate,
                                                                         com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                                  throws com.liferay.portal.kernel.exception.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.

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)

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:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

addFileShortcut

public com.liferay.portal.kernel.repository.model.FileShortcut addFileShortcut(long userId,
                                                                               long repositoryId,
                                                                               long folderId,
                                                                               long toFileEntryId,
                                                                               com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                                        throws com.liferay.portal.kernel.exception.PortalException

Adds the file shortcut to the existing file entry. This method is only supported by the Liferay repository.

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:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

addFolder

public com.liferay.portal.kernel.repository.model.Folder addFolder(long userId,
                                                                   long repositoryId,
                                                                   long parentFolderId,
                                                                   String name,
                                                                   String description,
                                                                   com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                            throws com.liferay.portal.kernel.exception.PortalException

Adds a folder.

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:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

deleteAll

public void deleteAll(long repositoryId)
               throws com.liferay.portal.kernel.exception.PortalException

Delete all data associated to the given repository. This method is only supported by the Liferay repository.

Parameters:

repositoryId - the primary key of the data's repository

Throws:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

deleteAllRepositories

public void deleteAllRepositories(long groupId)
                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteFileEntry

public void deleteFileEntry(long fileEntryId)
                     throws com.liferay.portal.kernel.exception.PortalException

Deletes the file entry.

Parameters:

fileEntryId - the primary key of the file entry

Throws:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

deleteFileShortcut

public void deleteFileShortcut(com.liferay.portal.kernel.repository.model.FileShortcut fileShortcut)
                        throws com.liferay.portal.kernel.exception.PortalException

Deletes the file shortcut. This method is only supported by the Liferay repository.

Parameters:

fileShortcut - the file shortcut

Throws:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

deleteFileShortcut

public void deleteFileShortcut(long fileShortcutId)
                        throws com.liferay.portal.kernel.exception.PortalException

Deletes the file shortcut. This method is only supported by the Liferay repository.

Parameters:

fileShortcutId - the primary key of the file shortcut

Throws:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

deleteFileShortcuts

public void deleteFileShortcuts(long toFileEntryId)
                         throws com.liferay.portal.kernel.exception.PortalException

Deletes all file shortcuts associated to the file entry. This method is only supported by the Liferay repository.

Parameters:

toFileEntryId - the primary key of the associated file entry

Throws:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

deleteFileVersion

public void deleteFileVersion(long fileVersionId)
                       throws com.liferay.portal.kernel.exception.PortalException

Deletes the file version. File versions can only be deleted if it is approved and there are other approved file versions available.

Parameters:

fileVersionId - the primary key of the file version

Throws:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

deleteFolder

public void deleteFolder(long folderId)
                  throws com.liferay.portal.kernel.exception.PortalException

Deletes the folder and all of its subfolders and file entries.

Parameters:

folderId - the primary key of the folder

Throws:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

fetchFileEntryByExternalReferenceCode

public com.liferay.portal.kernel.repository.model.FileEntry fetchFileEntryByExternalReferenceCode(long groupId,
                                                                                                  String externalReferenceCode)
                                                                                           throws com.liferay.portal.kernel.exception.PortalException

Returns the document library file entry with the matching external reference code and group.

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:

com.liferay.portal.kernel.exception.PortalException

getFileEntry

public com.liferay.portal.kernel.repository.model.FileEntry getFileEntry(long fileEntryId)
                                                                  throws com.liferay.portal.kernel.exception.PortalException

Returns the file entry with the primary key.

Parameters:

fileEntryId - the primary key of the file entry

Returns:

the file entry with the primary key

Throws:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

getFileEntry

public com.liferay.portal.kernel.repository.model.FileEntry getFileEntry(long groupId,
                                                                         long folderId,
                                                                         String title)
                                                                  throws com.liferay.portal.kernel.exception.PortalException

Returns the file entry with the title in the folder.

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:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

getFileEntryByExternalReferenceCode

public com.liferay.portal.kernel.repository.model.FileEntry getFileEntryByExternalReferenceCode(long groupId,
                                                                                                String externalReferenceCode)
                                                                                         throws com.liferay.portal.kernel.exception.PortalException

Returns the file entry with the external reference code.

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:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

getFileEntryByFileName

public com.liferay.portal.kernel.repository.model.FileEntry getFileEntryByFileName(long groupId,
                                                                                   long folderId,
                                                                                   String fileName)
                                                                            throws com.liferay.portal.kernel.exception.PortalException

Returns the file entry with the file name in the folder.

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:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

getFileEntryByUuidAndGroupId

public com.liferay.portal.kernel.repository.model.FileEntry getFileEntryByUuidAndGroupId(String uuid,
                                                                                         long groupId)
                                                                                  throws com.liferay.portal.kernel.exception.PortalException

Returns the file entry with the UUID and group.

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:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

getFileShortcut

public com.liferay.portal.kernel.repository.model.FileShortcut getFileShortcut(long fileShortcutId)
                                                                        throws com.liferay.portal.kernel.exception.PortalException

Returns the file shortcut with the primary key. This method is only supported by the Liferay repository.

Parameters:

fileShortcutId - the primary key of the file shortcut

Returns:

the file shortcut with the primary key

Throws:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

getFileVersion

public com.liferay.portal.kernel.repository.model.FileVersion getFileVersion(long fileVersionId)
                                                                      throws com.liferay.portal.kernel.exception.PortalException

Returns the file version with the primary key.

Parameters:

fileVersionId - the primary key of the file version

Returns:

the file version with the primary key

Throws:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

getFolder

public com.liferay.portal.kernel.repository.model.Folder getFolder(long folderId)
                                                            throws com.liferay.portal.kernel.exception.PortalException

Returns the folder with the primary key.

Parameters:

folderId - the primary key of the folder

Returns:

the folder with the primary key

Throws:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

getFolder

public com.liferay.portal.kernel.repository.model.Folder getFolder(long repositoryId,
                                                                   long parentFolderId,
                                                                   String name)
                                                            throws com.liferay.portal.kernel.exception.PortalException

Returns the folder with the name in the parent folder.

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:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

getMountFolder

public com.liferay.portal.kernel.repository.model.Folder getMountFolder(long repositoryId)
                                                                 throws com.liferay.portal.kernel.exception.PortalException

Returns the mount folder of the repository with the primary key. This method is only supported by the Liferay repository.

Parameters:

repositoryId - the primary key of the repository

Returns:

the folder used for mounting third-party repositories

Throws:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

moveFileEntry

public com.liferay.portal.kernel.repository.model.FileEntry moveFileEntry(long userId,
                                                                          long fileEntryId,
                                                                          long newFolderId,
                                                                          com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                                   throws com.liferay.portal.kernel.exception.PortalException

Moves the file entry to the new folder.

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:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

moveFolder

public com.liferay.portal.kernel.repository.model.Folder moveFolder(long userId,
                                                                    long folderId,
                                                                    long parentFolderId,
                                                                    com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                             throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

subscribeFileEntryType

public void subscribeFileEntryType(long userId,
                                   long groupId,
                                   long fileEntryTypeId)
                            throws com.liferay.portal.kernel.exception.PortalException

Subscribe the user to changes in documents of the file entry type. This method is only supported by the Liferay repository.

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:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

subscribeFolder

public void subscribeFolder(long userId,
                            long groupId,
                            long folderId)
                     throws com.liferay.portal.kernel.exception.PortalException

Subscribe the user to document changes in the folder. This method is only supported by the Liferay repository.

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:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

unsubscribeFileEntryType

public void unsubscribeFileEntryType(long userId,
                                     long groupId,
                                     long fileEntryTypeId)
                              throws com.liferay.portal.kernel.exception.PortalException

Unsubscribe the user from changes in documents of the file entry type. This method is only supported by the Liferay repository.

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:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

unsubscribeFolder

public void unsubscribeFolder(long userId,
                              long groupId,
                              long folderId)
                       throws com.liferay.portal.kernel.exception.PortalException

Unsubscribe the user from document changes in the folder. This method is only supported by the Liferay repository.

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:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

updateAsset

public void updateAsset(long userId,
                        com.liferay.portal.kernel.repository.model.FileEntry fileEntry,
                        com.liferay.portal.kernel.repository.model.FileVersion fileVersion,
                        long[] assetCategoryIds,
                        String[] assetTagNames,
                        long[] assetLinkEntryIds)
                 throws com.liferay.portal.kernel.exception.PortalException

Updates the file entry's asset replacing its asset categories, tags, and links.

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:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

updateFileEntry

public com.liferay.portal.kernel.repository.model.FileEntry updateFileEntry(long userId,
                                                                            long fileEntryId,
                                                                            String sourceFileName,
                                                                            String mimeType,
                                                                            String title,
                                                                            String urlTitle,
                                                                            String description,
                                                                            String changeLog,
                                                                            com.liferay.document.library.kernel.model.DLVersionNumberIncrease dlVersionNumberIncrease,
                                                                            byte[] bytes,
                                                                            Date expirationDate,
                                                                            Date reviewDate,
                                                                            com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                                     throws com.liferay.portal.kernel.exception.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.

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)

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:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

updateFileEntry

public com.liferay.portal.kernel.repository.model.FileEntry updateFileEntry(long userId,
                                                                            long fileEntryId,
                                                                            String sourceFileName,
                                                                            String mimeType,
                                                                            String title,
                                                                            String urlTitle,
                                                                            String description,
                                                                            String changeLog,
                                                                            com.liferay.document.library.kernel.model.DLVersionNumberIncrease dlVersionNumberIncrease,
                                                                            File file,
                                                                            Date expirationDate,
                                                                            Date reviewDate,
                                                                            com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                                     throws com.liferay.portal.kernel.exception.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.

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)

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:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

updateFileEntry

public com.liferay.portal.kernel.repository.model.FileEntry updateFileEntry(long userId,
                                                                            long fileEntryId,
                                                                            String sourceFileName,
                                                                            String mimeType,
                                                                            String title,
                                                                            String urlTitle,
                                                                            String description,
                                                                            String changeLog,
                                                                            com.liferay.document.library.kernel.model.DLVersionNumberIncrease dlVersionNumberIncrease,
                                                                            InputStream inputStream,
                                                                            long size,
                                                                            Date expirationDate,
                                                                            Date reviewDate,
                                                                            com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                                     throws com.liferay.portal.kernel.exception.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.

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)

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:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

updateFileShortcut

public com.liferay.portal.kernel.repository.model.FileShortcut updateFileShortcut(long userId,
                                                                                  long fileShortcutId,
                                                                                  long folderId,
                                                                                  long toFileEntryId,
                                                                                  com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                                           throws com.liferay.portal.kernel.exception.PortalException

Updates a file shortcut to the existing file entry. This method is only supported by the Liferay repository.

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:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

updateFileShortcuts

public void updateFileShortcuts(long oldToFileEntryId,
                                long newToFileEntryId)
                         throws com.liferay.portal.kernel.exception.PortalException

Updates all file shortcuts to the existing file entry to the new file entry. This method is only supported by the Liferay repository.

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:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

updateFolder

public com.liferay.portal.kernel.repository.model.Folder updateFolder(long folderId,
                                                                      long parentFolderId,
                                                                      String name,
                                                                      String description,
                                                                      com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                               throws com.liferay.portal.kernel.exception.PortalException

Updates the folder.

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:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

copyFileEntry

protected com.liferay.portal.kernel.repository.model.FileEntry copyFileEntry(long userId,
                                                                             com.liferay.portal.kernel.repository.LocalRepository toLocalRepository,
                                                                             com.liferay.portal.kernel.repository.model.FileEntry fileEntry,
                                                                             long newFolderId,
                                                                             com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                                      throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

copyFolder

protected com.liferay.portal.kernel.repository.model.Folder copyFolder(long userId,
                                                                       long folderId,
                                                                       long parentFolderId,
                                                                       com.liferay.portal.kernel.repository.LocalRepository fromLocalRepository,
                                                                       com.liferay.portal.kernel.repository.LocalRepository toLocalRepository,
                                                                       com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                                throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

copyFolderDependencies

protected void copyFolderDependencies(long userId,
                                      com.liferay.portal.kernel.repository.model.Folder sourceFolder,
                                      com.liferay.portal.kernel.repository.model.Folder destinationFolder,
                                      com.liferay.portal.kernel.repository.LocalRepository fromLocalRepository,
                                      com.liferay.portal.kernel.repository.LocalRepository toLocalRepository,
                                      com.liferay.portal.kernel.service.ServiceContext serviceContext)
                               throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteFileEntry

protected void deleteFileEntry(long oldFileEntryId,
                               long newFileEntryId,
                               com.liferay.portal.kernel.repository.LocalRepository fromLocalRepository,
                               com.liferay.portal.kernel.repository.LocalRepository toLocalRepository)
                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteRepository

protected void deleteRepository(com.liferay.portal.kernel.repository.LocalRepository localRepository)
                         throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getFolderLocalRepository

protected com.liferay.portal.kernel.repository.LocalRepository getFolderLocalRepository(long folderId,
                                                                                        long groupId)
                                                                                 throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getLocalRepository

protected com.liferay.portal.kernel.repository.LocalRepository getLocalRepository(long repositoryId)
                                                                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

moveFileEntry

protected com.liferay.portal.kernel.repository.model.FileEntry moveFileEntry(long userId,
                                                                             long fileEntryId,
                                                                             long newFolderId,
                                                                             com.liferay.portal.kernel.repository.LocalRepository fromLocalRepository,
                                                                             com.liferay.portal.kernel.repository.LocalRepository toLocalRepository,
                                                                             com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                                      throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

moveFolder

protected com.liferay.portal.kernel.repository.model.Folder moveFolder(long userId,
                                                                       long folderId,
                                                                       long parentFolderId,
                                                                       com.liferay.portal.kernel.repository.LocalRepository fromLocalRepository,
                                                                       com.liferay.portal.kernel.repository.LocalRepository toLocalRepository,
                                                                       com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                                throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException