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

java.lang.Object
  com.liferay.portlet.documentlibrary.service.base.DLAppLocalServiceBaseImpl
      com.liferay.portlet.documentlibrary.service.impl.DLAppLocalServiceImpl

All Implemented Interfaces:

com.liferay.portal.kernel.bean.IdentifiableBean, com.liferay.portlet.documentlibrary.service.DLAppLocalService

public class DLAppLocalServiceImpl
extends DLAppLocalServiceBaseImpl

The document library local service. All portlets should interact with the document library through this class or through DLAppServiceImpl, 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 inherited from class com.liferay.portlet.documentlibrary.service.base.DLAppLocalServiceBaseImpl

counterLocalService, dlAppHelperLocalService, dlAppLocalService, dlAppService, dlContentLocalService, dlContentPersistence, dlFileEntryFinder, dlFileEntryLocalService, dlFileEntryMetadataLocalService, dlFileEntryMetadataPersistence, dlFileEntryPersistence, dlFileEntryService, dlFileEntryTypeFinder, dlFileEntryTypeLocalService, dlFileEntryTypePersistence, dlFileEntryTypeService, dlFileRankFinder, dlFileRankLocalService, dlFileRankPersistence, dlFileShortcutLocalService, dlFileShortcutPersistence, dlFileShortcutService, dlFileVersionLocalService, dlFileVersionPersistence, dlFileVersionService, dlFolderFinder, dlFolderLocalService, dlFolderPersistence, dlFolderService, dlSyncLocalService, dlSyncPersistence, dlSyncService, lockFinder, lockLocalService, lockPersistence, repositoryEntryLocalService, repositoryEntryPersistence, repositoryLocalService, repositoryPersistence, repositoryService, resourceFinder, resourceLocalService, resourcePersistence, resourceService, userFinder, userLocalService, userPersistence, userService

Constructor Summary

DLAppLocalServiceImpl()

Method Summary

com.liferay.portal.kernel.repository.model.FileEntry	addFileEntry(long userId, long repositoryId, long folderId, java.lang.String sourceFileName, java.lang.String mimeType, java.lang.String title, java.lang.String description, java.lang.String changeLog, byte[] bytes, com.liferay.portal.service.ServiceContext serviceContext) Adds a file entry and associated metadata based on a byte array.
com.liferay.portal.kernel.repository.model.FileEntry	addFileEntry(long userId, long repositoryId, long folderId, java.lang.String sourceFileName, java.lang.String mimeType, java.lang.String title, java.lang.String description, java.lang.String changeLog, java.io.File file, com.liferay.portal.service.ServiceContext serviceContext) Adds a file entry and associated metadata based on a File object.
com.liferay.portal.kernel.repository.model.FileEntry	addFileEntry(long userId, long repositoryId, long folderId, java.lang.String sourceFileName, java.lang.String mimeType, java.lang.String title, java.lang.String description, java.lang.String changeLog, java.io.InputStream is, long size, com.liferay.portal.service.ServiceContext serviceContext) Adds a file entry and associated metadata based on an InputStream object.
com.liferay.portlet.documentlibrary.model.DLFileRank	addFileRank(long repositoryId, long companyId, long userId, long fileEntryId, com.liferay.portal.service.ServiceContext serviceContext) Adds the file rank to the existing file entry.
com.liferay.portlet.documentlibrary.model.DLFileShortcut	addFileShortcut(long userId, long repositoryId, long folderId, long toFileEntryId, com.liferay.portal.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, java.lang.String name, java.lang.String description, com.liferay.portal.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.service.ServiceContext serviceContext)
void	deleteAll(long repositoryId) Delete all data associated to the given repository.
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	deleteFileRanksByFileEntryId(long fileEntryId) Deletes the file ranks associated to a given file entry.
void	deleteFileRanksByUserId(long userId) Deletes the file ranks associated to a given user.
void	deleteFileShortcut(com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut) 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.
java.util.List<com.liferay.portal.kernel.repository.model.FileEntry>	getFileEntries(long repositoryId, long folderId) Returns the file entries in the folder.
java.util.List<com.liferay.portal.kernel.repository.model.FileEntry>	getFileEntries(long repositoryId, long folderId, int start, int end) Returns a range of all the file entries in the folder.
java.util.List<com.liferay.portal.kernel.repository.model.FileEntry>	getFileEntries(long repositoryId, long folderId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc) Returns an ordered range of all the file entries in the folder.
java.util.List<java.lang.Object>	getFileEntriesAndFileShortcuts(long repositoryId, long folderId, int status, int start, int end) Returns a range of all the file entries and shortcuts in the folder.
int	getFileEntriesAndFileShortcutsCount(long repositoryId, long folderId, int status) Returns the number of file entries and shortcuts in the folder.
int	getFileEntriesCount(long repositoryId, long folderId) Returns the number of file entries in the folder.
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, java.lang.String title) Returns the file entry with the title in the folder.
com.liferay.portal.kernel.repository.model.FileEntry	getFileEntryByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the file entry with the UUID and group.
java.util.List<com.liferay.portlet.documentlibrary.model.DLFileRank>	getFileRanks(long repositoryId, long userId) Returns the file ranks from the user.
com.liferay.portlet.documentlibrary.model.DLFileShortcut	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, java.lang.String name) Returns the folder with the name in the parent folder.
java.util.List<com.liferay.portal.kernel.repository.model.Folder>	getFolders(long repositoryId, long parentFolderId) Returns all immediate subfolders of the parent folder.
java.util.List<com.liferay.portal.kernel.repository.model.Folder>	getFolders(long repositoryId, long parentFolderId, boolean includeMountFolders) Returns all immediate subfolders of the parent folder, optionally including mount folders for third-party repositories.
java.util.List<com.liferay.portal.kernel.repository.model.Folder>	getFolders(long repositoryId, long parentFolderId, boolean includeMountFolders, int start, int end) Returns a range of all the immediate subfolders of the parent folder, optionally including mount folders for third-party repositories.
java.util.List<com.liferay.portal.kernel.repository.model.Folder>	getFolders(long repositoryId, long parentFolderId, boolean includeMountFolders, int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc) Returns an ordered range of all the immediate subfolders of the parent folder.
java.util.List<com.liferay.portal.kernel.repository.model.Folder>	getFolders(long repositoryId, long parentFolderId, int start, int end) Returns a range of all the immediate subfolders of the parent folder.
java.util.List<com.liferay.portal.kernel.repository.model.Folder>	getFolders(long repositoryId, long parentFolderId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc) Returns an ordered range of all the immediate subfolders of the parent folder.
java.util.List<java.lang.Object>	getFoldersAndFileEntriesAndFileShortcuts(long repositoryId, long folderId, int status, boolean includeMountFolders, int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc) Returns an ordered range of all the immediate subfolders, file entries, and file shortcuts in the parent folder.
java.util.List<java.lang.Object>	getFoldersAndFileEntriesAndFileShortcuts(long repositoryId, long folderId, int status, java.lang.String[] mimeTypes, boolean includeMountFolders, int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
int	getFoldersAndFileEntriesAndFileShortcutsCount(long repositoryId, long folderId, int status, boolean includeMountFolders) Returns the number of immediate subfolders, file entries, and file shortcuts in the parent folder.
int	getFoldersAndFileEntriesAndFileShortcutsCount(long repositoryId, long folderId, int status, java.lang.String[] mimeTypes, boolean includeMountFolders)
int	getFoldersCount(long repositoryId, long parentFolderId) Returns the number of immediate subfolders of the parent folder.
int	getFoldersCount(long repositoryId, long parentFolderId, boolean includeMountFolders) Returns the number of immediate subfolders of the parent folder, optionally including mount folders for third-party repositories.
int	getFoldersFileEntriesCount(long repositoryId, java.util.List<java.lang.Long> folderIds, int status) Returns the number of immediate subfolders and file entries across the folders.
protected com.liferay.portal.kernel.repository.LocalRepository	getLocalRepository(long repositoryId)
protected com.liferay.portal.kernel.repository.LocalRepository	getLocalRepository(long folderId, long fileEntryId, long fileVersionId)
protected com.liferay.portal.kernel.repository.LocalRepository	getLocalRepository(long folderId, com.liferay.portal.service.ServiceContext serviceContext)
com.liferay.portal.kernel.repository.model.Folder	getMountFolder(long repositoryId) Returns the mount folder of the repository with the primary key.
java.util.List<com.liferay.portal.kernel.repository.model.Folder>	getMountFolders(long repositoryId, long parentFolderId) Returns all immediate subfolders of the parent folder that are used for mounting third-party repositories.
java.util.List<com.liferay.portal.kernel.repository.model.Folder>	getMountFolders(long repositoryId, long parentFolderId, int start, int end) Returns a range of all the immediate subfolders of the parent folder that are used for mounting third-party repositories.
java.util.List<com.liferay.portal.kernel.repository.model.Folder>	getMountFolders(long repositoryId, long parentFolderId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc) Returns an ordered range of all the immediate subfolders of the parent folder that are used for mounting third-party repositories.
int	getMountFoldersCount(long repositoryId, long parentFolderId) Returns the number of immediate subfolders of the parent folder that are used for mounting third-party repositories.
protected boolean	isMajorVersion(com.liferay.portal.kernel.repository.model.FileVersion previousFileVersion, com.liferay.portal.kernel.repository.model.FileVersion currentFileVersion)
protected com.liferay.portal.kernel.repository.model.FileEntry	moveFileEntries(long userId, long fileEntryId, long newFolderId, com.liferay.portal.kernel.repository.LocalRepository fromLocalRepository, com.liferay.portal.kernel.repository.LocalRepository toLocalRepository, com.liferay.portal.service.ServiceContext serviceContext)
com.liferay.portal.kernel.repository.model.FileEntry	moveFileEntry(long userId, long fileEntryId, long newFolderId, com.liferay.portal.service.ServiceContext serviceContext) Moves the file entry to the new folder.
void	updateAsset(long userId, com.liferay.portal.kernel.repository.model.FileEntry fileEntry, com.liferay.portal.kernel.repository.model.FileVersion fileVersion, long[] assetCategoryIds, java.lang.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, java.lang.String sourceFileName, java.lang.String mimeType, java.lang.String title, java.lang.String description, java.lang.String changeLog, boolean majorVersion, byte[] bytes, com.liferay.portal.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, java.lang.String sourceFileName, java.lang.String mimeType, java.lang.String title, java.lang.String description, java.lang.String changeLog, boolean majorVersion, java.io.File file, com.liferay.portal.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, java.lang.String sourceFileName, java.lang.String mimeType, java.lang.String title, java.lang.String description, java.lang.String changeLog, boolean majorVersion, java.io.InputStream is, long size, com.liferay.portal.service.ServiceContext serviceContext) Updates a file entry and associated metadata based on an InputStream object.
com.liferay.portlet.documentlibrary.model.DLFileRank	updateFileRank(long repositoryId, long companyId, long userId, long fileEntryId, com.liferay.portal.service.ServiceContext serviceContext) Updates a file rank to the existing file entry.
com.liferay.portlet.documentlibrary.model.DLFileShortcut	updateFileShortcut(long userId, long fileShortcutId, long folderId, long toFileEntryId, com.liferay.portal.service.ServiceContext serviceContext) Updates a file shortcut to the existing file entry.
void	updateFileShortcuts(long toRepositoryId, 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, java.lang.String name, java.lang.String description, com.liferay.portal.service.ServiceContext serviceContext) Updates the folder.

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

afterPropertiesSet, destroy, getBeanIdentifier, getCounterLocalService, getDLAppHelperLocalService, getDLAppLocalService, getDLAppService, getDLContentLocalService, getDLContentPersistence, getDLFileEntryFinder, getDLFileEntryLocalService, getDLFileEntryMetadataLocalService, getDLFileEntryMetadataPersistence, getDLFileEntryPersistence, getDLFileEntryService, getDLFileEntryTypeFinder, getDLFileEntryTypeLocalService, getDLFileEntryTypePersistence, getDLFileEntryTypeService, getDLFileRankFinder, getDLFileRankLocalService, getDLFileRankPersistence, getDLFileShortcutLocalService, getDLFileShortcutPersistence, getDLFileShortcutService, getDLFileVersionLocalService, getDLFileVersionPersistence, getDLFileVersionService, getDLFolderFinder, getDLFolderLocalService, getDLFolderPersistence, getDLFolderService, getDLSyncLocalService, getDLSyncPersistence, getDLSyncService, getLockFinder, getLockLocalService, getLockPersistence, getRepositoryEntryLocalService, getRepositoryEntryPersistence, getRepositoryLocalService, getRepositoryPersistence, getRepositoryService, getResourceFinder, getResourceLocalService, getResourcePersistence, getResourceService, getUserFinder, getUserLocalService, getUserPersistence, getUserService, runSQL, setBeanIdentifier, setCounterLocalService, setDLAppHelperLocalService, setDLAppLocalService, setDLAppService, setDLContentLocalService, setDLContentPersistence, setDLFileEntryFinder, setDLFileEntryLocalService, setDLFileEntryMetadataLocalService, setDLFileEntryMetadataPersistence, setDLFileEntryPersistence, setDLFileEntryService, setDLFileEntryTypeFinder, setDLFileEntryTypeLocalService, setDLFileEntryTypePersistence, setDLFileEntryTypeService, setDLFileRankFinder, setDLFileRankLocalService, setDLFileRankPersistence, setDLFileShortcutLocalService, setDLFileShortcutPersistence, setDLFileShortcutService, setDLFileVersionLocalService, setDLFileVersionPersistence, setDLFileVersionService, setDLFolderFinder, setDLFolderLocalService, setDLFolderPersistence, setDLFolderService, setDLSyncLocalService, setDLSyncPersistence, setDLSyncService, setLockFinder, setLockLocalService, setLockPersistence, setRepositoryEntryLocalService, setRepositoryEntryPersistence, setRepositoryLocalService, setRepositoryPersistence, setRepositoryService, setResourceFinder, setResourceLocalService, setResourcePersistence, setResourceService, setUserFinder, setUserLocalService, setUserPersistence, setUserService

Methods inherited from class java.lang.Object

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

Constructor Detail

DLAppLocalServiceImpl

public DLAppLocalServiceImpl()

Method Detail

addFileEntry

public com.liferay.portal.kernel.repository.model.FileEntry addFileEntry(long userId,
                                                                         long repositoryId,
                                                                         long folderId,
                                                                         java.lang.String sourceFileName,
                                                                         java.lang.String mimeType,
                                                                         java.lang.String title,
                                                                         java.lang.String description,
                                                                         java.lang.String changeLog,
                                                                         byte[] bytes,
                                                                         com.liferay.portal.service.ServiceContext serviceContext)
                                                                  throws com.liferay.portal.kernel.exception.PortalException,
                                                                         com.liferay.portal.kernel.exception.SystemException

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:

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:

com.liferay.portal.kernel.exception.PortalException - if the parent folder could not be found or if the file entry's information was invalid

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

addFileEntry

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

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 the parent folder could not be found or if the file entry's information was invalid

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

addFileEntry

public com.liferay.portal.kernel.repository.model.FileEntry addFileEntry(long userId,
                                                                         long repositoryId,
                                                                         long folderId,
                                                                         java.lang.String sourceFileName,
                                                                         java.lang.String mimeType,
                                                                         java.lang.String title,
                                                                         java.lang.String description,
                                                                         java.lang.String changeLog,
                                                                         java.io.InputStream is,
                                                                         long size,
                                                                         com.liferay.portal.service.ServiceContext serviceContext)
                                                                  throws com.liferay.portal.kernel.exception.PortalException,
                                                                         com.liferay.portal.kernel.exception.SystemException

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:

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:

com.liferay.portal.kernel.exception.PortalException - if the parent folder could not be found or if the file entry's information was invalid

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

addFileRank

public com.liferay.portlet.documentlibrary.model.DLFileRank addFileRank(long repositoryId,
                                                                        long companyId,
                                                                        long userId,
                                                                        long fileEntryId,
                                                                        com.liferay.portal.service.ServiceContext serviceContext)
                                                                 throws com.liferay.portal.kernel.exception.SystemException

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

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

Throws:

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

addFileShortcut

public com.liferay.portlet.documentlibrary.model.DLFileShortcut addFileShortcut(long userId,
                                                                                long repositoryId,
                                                                                long folderId,
                                                                                long toFileEntryId,
                                                                                com.liferay.portal.service.ServiceContext serviceContext)
                                                                         throws com.liferay.portal.kernel.exception.PortalException,
                                                                                com.liferay.portal.kernel.exception.SystemException

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 the parent folder or file entry could not be found, or if the file shortcut's information was invalid

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

addFolder

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

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 the parent folder could not be found or if the new folder's information was invalid

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

deleteAll

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

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 the repository could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

deleteFileEntry

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

Deletes the file entry.

Parameters:

fileEntryId - the primary key of the file entry

Throws:

com.liferay.portal.kernel.exception.PortalException - if the file entry could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

deleteFileRanksByFileEntryId

public void deleteFileRanksByFileEntryId(long fileEntryId)
                                  throws com.liferay.portal.kernel.exception.SystemException

Deletes the file ranks associated to a given file entry. This method is only supported by the Liferay repository.

Parameters:

fileEntryId - the primary key of the file entry

Throws:

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

deleteFileRanksByUserId

public void deleteFileRanksByUserId(long userId)
                             throws com.liferay.portal.kernel.exception.SystemException

Deletes the file ranks associated to a given user. This method is only supported by the Liferay repository.

Parameters:

userId - the primary key of the user

Throws:

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

deleteFileShortcut

public void deleteFileShortcut(com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut)
                        throws com.liferay.portal.kernel.exception.PortalException,
                               com.liferay.portal.kernel.exception.SystemException

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

Parameters:

dlFileShortcut - the file shortcut

Throws:

com.liferay.portal.kernel.exception.PortalException - if the file shortcut could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

deleteFileShortcut

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

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 the file shortcut could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

deleteFileShortcuts

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

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 the file shortcut for the file entry could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

deleteFolder

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

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 the folder could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getFileEntries

public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getFileEntries(long repositoryId,
                                                                                           long folderId)
                                                                                    throws com.liferay.portal.kernel.exception.PortalException,
                                                                                           com.liferay.portal.kernel.exception.SystemException

Returns the file entries in the folder.

Parameters:

repositoryId - the primary key of the file entry's repository

folderId - the primary key of the file entry's folder

Returns:

the file entries in the folder

Throws:

com.liferay.portal.kernel.exception.PortalException - if the folder could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getFileEntries

public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getFileEntries(long repositoryId,
                                                                                           long folderId,
                                                                                           int start,
                                                                                           int end)
                                                                                    throws com.liferay.portal.kernel.exception.PortalException,
                                                                                           com.liferay.portal.kernel.exception.SystemException

Returns a range of all the file entries in the folder.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

repositoryId - the primary key of the file entry's repository

folderId - the primary key of the file entry's folder

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

Returns:

the range of file entries in the folder

Throws:

com.liferay.portal.kernel.exception.PortalException - if the folder could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getFileEntries

public java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> getFileEntries(long repositoryId,
                                                                                           long folderId,
                                                                                           int start,
                                                                                           int end,
                                                                                           com.liferay.portal.kernel.util.OrderByComparator obc)
                                                                                    throws com.liferay.portal.kernel.exception.PortalException,
                                                                                           com.liferay.portal.kernel.exception.SystemException

Returns an ordered range of all the file entries in the folder.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

repositoryId - the primary key of the file entry's repository

folderId - the primary key of the file entry's folder

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

obc - the comparator to order the file entries (optionally null)

Returns:

the range of file entries in the folder ordered by comparator obc

Throws:

com.liferay.portal.kernel.exception.PortalException - if the folder could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getFileEntriesAndFileShortcuts

public java.util.List<java.lang.Object> getFileEntriesAndFileShortcuts(long repositoryId,
                                                                       long folderId,
                                                                       int status,
                                                                       int start,
                                                                       int end)
                                                                throws com.liferay.portal.kernel.exception.PortalException,
                                                                       com.liferay.portal.kernel.exception.SystemException

Returns a range of all the file entries and shortcuts in the folder.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

repositoryId - the primary key of the repository

folderId - the primary key of the folder

status - the workflow status

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

Returns:

the range of file entries and shortcuts in the folder

Throws:

com.liferay.portal.kernel.exception.PortalException - if the folder could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getFileEntriesAndFileShortcutsCount

public int getFileEntriesAndFileShortcutsCount(long repositoryId,
                                               long folderId,
                                               int status)
                                        throws com.liferay.portal.kernel.exception.PortalException,
                                               com.liferay.portal.kernel.exception.SystemException

Returns the number of file entries and shortcuts in the folder.

Parameters:

repositoryId - the primary key of the repository

folderId - the primary key of the folder

status - the workflow status

Returns:

the number of file entries and shortcuts in the folder

Throws:

com.liferay.portal.kernel.exception.PortalException - if the folder could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getFileEntriesCount

public int getFileEntriesCount(long repositoryId,
                               long folderId)
                        throws com.liferay.portal.kernel.exception.PortalException,
                               com.liferay.portal.kernel.exception.SystemException

Returns the number of file entries in the folder.

Parameters:

repositoryId - the primary key of the file entry's repository

folderId - the primary key of the file entry's folder

Returns:

the number of file entries in the folder

Throws:

com.liferay.portal.kernel.exception.PortalException - if the folder could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getFileEntry

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

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 the file entry could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getFileEntry

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

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 the file entry could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getFileEntryByUuidAndGroupId

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

Returns the file entry with the UUID and group.

Parameters:

uuid - the file entry's universally unique identifier

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 the file entry could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getFileRanks

public java.util.List<com.liferay.portlet.documentlibrary.model.DLFileRank> getFileRanks(long repositoryId,
                                                                                         long userId)
                                                                                  throws com.liferay.portal.kernel.exception.SystemException

Returns the file ranks from the user. This method is only supported by the Liferay repository.

Parameters:

repositoryId - the primary key of the repository

userId - the primary key of the user

Returns:

the file ranks from the user

Throws:

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getFileShortcut

public com.liferay.portlet.documentlibrary.model.DLFileShortcut getFileShortcut(long fileShortcutId)
                                                                         throws com.liferay.portal.kernel.exception.PortalException,
                                                                                com.liferay.portal.kernel.exception.SystemException

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 the file shortcut could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getFileVersion

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

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 the file version could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getFolder

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

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 the folder could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getFolder

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

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 the folder could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getFolders

public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getFolders(long repositoryId,
                                                                                    long parentFolderId)
                                                                             throws com.liferay.portal.kernel.exception.PortalException,
                                                                                    com.liferay.portal.kernel.exception.SystemException

Returns all immediate subfolders of the parent folder.

Parameters:

repositoryId - the primary key of the folder's repository

parentFolderId - the primary key of the folder's parent folder

Returns:

the immediate subfolders of the parent folder

Throws:

com.liferay.portal.kernel.exception.PortalException - if the parent folder could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getFolders

public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getFolders(long repositoryId,
                                                                                    long parentFolderId,
                                                                                    boolean includeMountFolders)
                                                                             throws com.liferay.portal.kernel.exception.PortalException,
                                                                                    com.liferay.portal.kernel.exception.SystemException

Returns all immediate subfolders of the parent folder, optionally including mount folders for third-party repositories.

Parameters:

repositoryId - the primary key of the folder's repository

parentFolderId - the primary key of the folder's parent folder

includeMountFolders - whether to include mount folders for third-party repositories

Returns:

the immediate subfolders of the parent folder

Throws:

com.liferay.portal.kernel.exception.PortalException - if the parent folder could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getFolders

public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getFolders(long repositoryId,
                                                                                    long parentFolderId,
                                                                                    boolean includeMountFolders,
                                                                                    int start,
                                                                                    int end)
                                                                             throws com.liferay.portal.kernel.exception.PortalException,
                                                                                    com.liferay.portal.kernel.exception.SystemException

Returns a range of all the immediate subfolders of the parent folder, optionally including mount folders for third-party repositories.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

repositoryId - the primary key of the folder's repository

parentFolderId - the primary key of the folder's parent folder

includeMountFolders - whether to include mount folders for third-party repositories

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

Returns:

the range of immediate subfolders of the parent folder

Throws:

com.liferay.portal.kernel.exception.PortalException - if the parent folder could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getFolders

public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getFolders(long repositoryId,
                                                                                    long parentFolderId,
                                                                                    boolean includeMountFolders,
                                                                                    int start,
                                                                                    int end,
                                                                                    com.liferay.portal.kernel.util.OrderByComparator obc)
                                                                             throws com.liferay.portal.kernel.exception.PortalException,
                                                                                    com.liferay.portal.kernel.exception.SystemException

Returns an ordered range of all the immediate subfolders of the parent folder.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

repositoryId - the primary key of the folder's repository

parentFolderId - the primary key of the folder's parent folder

includeMountFolders - whether to include mount folders for third-party repositories

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

obc - the comparator to order the folders (optionally null)

Returns:

the range of immediate subfolders of the parent folder ordered by comparator obc

Throws:

com.liferay.portal.kernel.exception.PortalException - if the parent folder could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getFolders

public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getFolders(long repositoryId,
                                                                                    long parentFolderId,
                                                                                    int start,
                                                                                    int end)
                                                                             throws com.liferay.portal.kernel.exception.PortalException,
                                                                                    com.liferay.portal.kernel.exception.SystemException

Returns a range of all the immediate subfolders of the parent folder.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

repositoryId - the primary key of the folder's repository

parentFolderId - the primary key of the folder's parent folder

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

Returns:

the range of immediate subfolders of the parent folder

Throws:

com.liferay.portal.kernel.exception.PortalException - if the parent folder could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getFolders

public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getFolders(long repositoryId,
                                                                                    long parentFolderId,
                                                                                    int start,
                                                                                    int end,
                                                                                    com.liferay.portal.kernel.util.OrderByComparator obc)
                                                                             throws com.liferay.portal.kernel.exception.PortalException,
                                                                                    com.liferay.portal.kernel.exception.SystemException

Returns an ordered range of all the immediate subfolders of the parent folder.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

repositoryId - the primary key of the folder's repository

parentFolderId - the primary key of the folder's parent folder

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

obc - the comparator to order the folders (optionally null)

Returns:

the range of immediate subfolders of the parent folder ordered by comparator obc

Throws:

com.liferay.portal.kernel.exception.PortalException - if the parent folder could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getFoldersAndFileEntriesAndFileShortcuts

public java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(long repositoryId,
                                                                                 long folderId,
                                                                                 int status,
                                                                                 boolean includeMountFolders,
                                                                                 int start,
                                                                                 int end,
                                                                                 com.liferay.portal.kernel.util.OrderByComparator obc)
                                                                          throws com.liferay.portal.kernel.exception.PortalException,
                                                                                 com.liferay.portal.kernel.exception.SystemException

Returns an ordered range of all the immediate subfolders, file entries, and file shortcuts in the parent folder.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

repositoryId - the primary key of the repository

folderId - the primary key of the parent folder

status - the workflow status

includeMountFolders - whether to include mount folders for third-party repositories

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

obc - the comparator to order the results (optionally null)

Returns:

the range of immediate subfolders, file entries, and file shortcuts in the parent folder ordered by comparator obc

Throws:

com.liferay.portal.kernel.exception.PortalException - if the folder could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getFoldersAndFileEntriesAndFileShortcuts

public java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(long repositoryId,
                                                                                 long folderId,
                                                                                 int status,
                                                                                 java.lang.String[] mimeTypes,
                                                                                 boolean includeMountFolders,
                                                                                 int start,
                                                                                 int end,
                                                                                 com.liferay.portal.kernel.util.OrderByComparator obc)
                                                                          throws com.liferay.portal.kernel.exception.PortalException,
                                                                                 com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

getFoldersAndFileEntriesAndFileShortcutsCount

public int getFoldersAndFileEntriesAndFileShortcutsCount(long repositoryId,
                                                         long folderId,
                                                         int status,
                                                         boolean includeMountFolders)
                                                  throws com.liferay.portal.kernel.exception.PortalException,
                                                         com.liferay.portal.kernel.exception.SystemException

Returns the number of immediate subfolders, file entries, and file shortcuts in the parent folder.

Parameters:

repositoryId - the primary key of the repository

folderId - the primary key of the parent folder

status - the workflow status

includeMountFolders - whether to include mount folders for third-party repositories

Returns:

the number of immediate subfolders, file entries, and file shortcuts in the parent folder

Throws:

com.liferay.portal.kernel.exception.PortalException - if the folder could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getFoldersAndFileEntriesAndFileShortcutsCount

public int getFoldersAndFileEntriesAndFileShortcutsCount(long repositoryId,
                                                         long folderId,
                                                         int status,
                                                         java.lang.String[] mimeTypes,
                                                         boolean includeMountFolders)
                                                  throws com.liferay.portal.kernel.exception.PortalException,
                                                         com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

getFoldersCount

public int getFoldersCount(long repositoryId,
                           long parentFolderId)
                    throws com.liferay.portal.kernel.exception.PortalException,
                           com.liferay.portal.kernel.exception.SystemException

Returns the number of immediate subfolders of the parent folder.

Parameters:

repositoryId - the primary key of the folder's repository

parentFolderId - the primary key of the folder's parent folder

Returns:

the number of immediate subfolders of the parent folder

Throws:

com.liferay.portal.kernel.exception.PortalException - if the parent folder could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getFoldersCount

public int getFoldersCount(long repositoryId,
                           long parentFolderId,
                           boolean includeMountFolders)
                    throws com.liferay.portal.kernel.exception.PortalException,
                           com.liferay.portal.kernel.exception.SystemException

Returns the number of immediate subfolders of the parent folder, optionally including mount folders for third-party repositories.

Parameters:

repositoryId - the primary key of the folder's repository

parentFolderId - the primary key of the folder's parent folder

includeMountFolders - whether to include mount folders for third-party repositories

Returns:

the number of immediate subfolders of the parent folder

Throws:

com.liferay.portal.kernel.exception.PortalException - if the parent folder could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getFoldersFileEntriesCount

public int getFoldersFileEntriesCount(long repositoryId,
                                      java.util.List<java.lang.Long> folderIds,
                                      int status)
                               throws com.liferay.portal.kernel.exception.PortalException,
                                      com.liferay.portal.kernel.exception.SystemException

Returns the number of immediate subfolders and file entries across the folders.

Parameters:

repositoryId - the primary key of the repository

folderIds - the primary keys of folders from which to count immediate subfolders and file entries

status - the workflow status

Returns:

the number of immediate subfolders and file entries across the folders

Throws:

com.liferay.portal.kernel.exception.PortalException - if the repository could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getMountFolder

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

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 the repository or mount folder could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getMountFolders

public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getMountFolders(long repositoryId,
                                                                                         long parentFolderId)
                                                                                  throws com.liferay.portal.kernel.exception.PortalException,
                                                                                         com.liferay.portal.kernel.exception.SystemException

Returns all immediate subfolders of the parent folder that are used for mounting third-party repositories. This method is only supported by the Liferay repository.

Parameters:

repositoryId - the primary key of the folder's repository

parentFolderId - the primary key of the folder's parent folder

Returns:

the immediate subfolders of the parent folder that are used for mounting third-party repositories

Throws:

com.liferay.portal.kernel.exception.PortalException - if the repository or parent folder could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getMountFolders

public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getMountFolders(long repositoryId,
                                                                                         long parentFolderId,
                                                                                         int start,
                                                                                         int end)
                                                                                  throws com.liferay.portal.kernel.exception.PortalException,
                                                                                         com.liferay.portal.kernel.exception.SystemException

Returns a range of all the immediate subfolders of the parent folder that are used for mounting third-party repositories. This method is only supported by the Liferay repository.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

repositoryId - the primary key of the repository

parentFolderId - the primary key of the parent folder

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

Returns:

the range of immediate subfolders of the parent folder that are used for mounting third-party repositories

Throws:

com.liferay.portal.kernel.exception.PortalException - if the repository or parent folder could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getMountFolders

public java.util.List<com.liferay.portal.kernel.repository.model.Folder> getMountFolders(long repositoryId,
                                                                                         long parentFolderId,
                                                                                         int start,
                                                                                         int end,
                                                                                         com.liferay.portal.kernel.util.OrderByComparator obc)
                                                                                  throws com.liferay.portal.kernel.exception.PortalException,
                                                                                         com.liferay.portal.kernel.exception.SystemException

Returns an ordered range of all the immediate subfolders of the parent folder that are used for mounting third-party repositories. This method is only supported by the Liferay repository.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

repositoryId - the primary key of the folder's repository

parentFolderId - the primary key of the folder's parent folder

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

obc - the comparator to order the folders (optionally null)

Returns:

the range of immediate subfolders of the parent folder that are used for mounting third-party repositories ordered by comparator obc

Throws:

com.liferay.portal.kernel.exception.PortalException - if the repository or parent folder could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

getMountFoldersCount

public int getMountFoldersCount(long repositoryId,
                                long parentFolderId)
                         throws com.liferay.portal.kernel.exception.PortalException,
                                com.liferay.portal.kernel.exception.SystemException

Returns the number of immediate subfolders of the parent folder that are used for mounting third-party repositories. This method is only supported by the Liferay repository.

Parameters:

repositoryId - the primary key of the repository

parentFolderId - the primary key of the parent folder

Returns:

the number of folders of the parent folder that are used for mounting third-party repositories

Throws:

com.liferay.portal.kernel.exception.PortalException - if the repository or parent folder could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

moveFileEntry

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

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 the file entry or the new folder could not be found

com.liferay.portal.kernel.exception.SystemException - if a system 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,
                        java.lang.String[] assetTagNames,
                        long[] assetLinkEntryIds)
                 throws com.liferay.portal.kernel.exception.PortalException,
                        com.liferay.portal.kernel.exception.SystemException

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 the file entry or version could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

updateFileEntry

public com.liferay.portal.kernel.repository.model.FileEntry updateFileEntry(long userId,
                                                                            long fileEntryId,
                                                                            java.lang.String sourceFileName,
                                                                            java.lang.String mimeType,
                                                                            java.lang.String title,
                                                                            java.lang.String description,
                                                                            java.lang.String changeLog,
                                                                            boolean majorVersion,
                                                                            byte[] bytes,
                                                                            com.liferay.portal.service.ServiceContext serviceContext)
                                                                     throws com.liferay.portal.kernel.exception.PortalException,
                                                                            com.liferay.portal.kernel.exception.SystemException

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)

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:

com.liferay.portal.kernel.exception.PortalException - if the file entry could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

updateFileEntry

public com.liferay.portal.kernel.repository.model.FileEntry updateFileEntry(long userId,
                                                                            long fileEntryId,
                                                                            java.lang.String sourceFileName,
                                                                            java.lang.String mimeType,
                                                                            java.lang.String title,
                                                                            java.lang.String description,
                                                                            java.lang.String changeLog,
                                                                            boolean majorVersion,
                                                                            java.io.File file,
                                                                            com.liferay.portal.service.ServiceContext serviceContext)
                                                                     throws com.liferay.portal.kernel.exception.PortalException,
                                                                            com.liferay.portal.kernel.exception.SystemException

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)

majorVersion - whether the new file version is a major version

file - EntryId the primary key of the 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. 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 the file entry could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

updateFileEntry

public com.liferay.portal.kernel.repository.model.FileEntry updateFileEntry(long userId,
                                                                            long fileEntryId,
                                                                            java.lang.String sourceFileName,
                                                                            java.lang.String mimeType,
                                                                            java.lang.String title,
                                                                            java.lang.String description,
                                                                            java.lang.String changeLog,
                                                                            boolean majorVersion,
                                                                            java.io.InputStream is,
                                                                            long size,
                                                                            com.liferay.portal.service.ServiceContext serviceContext)
                                                                     throws com.liferay.portal.kernel.exception.PortalException,
                                                                            com.liferay.portal.kernel.exception.SystemException

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)

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:

com.liferay.portal.kernel.exception.PortalException - if the file entry could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

updateFileRank

public com.liferay.portlet.documentlibrary.model.DLFileRank updateFileRank(long repositoryId,
                                                                           long companyId,
                                                                           long userId,
                                                                           long fileEntryId,
                                                                           com.liferay.portal.service.ServiceContext serviceContext)
                                                                    throws com.liferay.portal.kernel.exception.SystemException

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

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

Throws:

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

updateFileShortcut

public com.liferay.portlet.documentlibrary.model.DLFileShortcut updateFileShortcut(long userId,
                                                                                   long fileShortcutId,
                                                                                   long folderId,
                                                                                   long toFileEntryId,
                                                                                   com.liferay.portal.service.ServiceContext serviceContext)
                                                                            throws com.liferay.portal.kernel.exception.PortalException,
                                                                                   com.liferay.portal.kernel.exception.SystemException

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 the file shortcut, folder, or file entry could not be found

com.liferay.portal.kernel.exception.SystemException - if a system exception occurred

updateFileShortcuts

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

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

Parameters:

toRepositoryId - the primary key of the repository

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.SystemException - if a system exception occurred

updateFolder

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

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
• fileEntryTypeSearchContainerPrimaryKeys - a comma-delimited list of file entry type primary keys allowed in the given folder and all descendants
• mountPoint - boolean specifying whether folder is a facade for mounting a third-party repository
• overrideFileEntryTypes - boolean specifying whether to override ancestral folder's restriction 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 the current or new parent folder could not be found, or if the new parent folder's information was invalid

com.liferay.portal.kernel.exception.SystemException - if a system 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.service.ServiceContext serviceContext)
                                                                      throws com.liferay.portal.kernel.exception.PortalException,
                                                                             com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

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,
                               com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

getLocalRepository

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

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

getLocalRepository

protected com.liferay.portal.kernel.repository.LocalRepository getLocalRepository(long folderId,
                                                                                  long fileEntryId,
                                                                                  long fileVersionId)
                                                                           throws com.liferay.portal.kernel.exception.PortalException,
                                                                                  com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

getLocalRepository

protected com.liferay.portal.kernel.repository.LocalRepository getLocalRepository(long folderId,
                                                                                  com.liferay.portal.service.ServiceContext serviceContext)
                                                                           throws com.liferay.portal.kernel.exception.PortalException,
                                                                                  com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

isMajorVersion

protected boolean isMajorVersion(com.liferay.portal.kernel.repository.model.FileVersion previousFileVersion,
                                 com.liferay.portal.kernel.repository.model.FileVersion currentFileVersion)

moveFileEntries

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

Throws:

com.liferay.portal.kernel.exception.SystemException

com.liferay.portal.kernel.exception.PortalException