com.liferay.portlet.documentlibrary.service
Class DLAppLocalServiceWrapper

java.lang.Object
  com.liferay.portlet.documentlibrary.service.DLAppLocalServiceWrapper

All Implemented Interfaces:

BaseLocalService, ServiceWrapper<DLAppLocalService>, DLAppLocalService

public class DLAppLocalServiceWrapper
extends Object
implements DLAppLocalService, ServiceWrapper<DLAppLocalService>

This class is a wrapper for DLAppLocalService.

See Also:

DLAppLocalService

Constructor Summary

DLAppLocalServiceWrapper(DLAppLocalService dlAppLocalService)

Method Summary

FileEntry	addFileEntry(long userId, long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String description, String changeLog, byte[] bytes, ServiceContext serviceContext) Adds a file entry and associated metadata based on a byte array.
FileEntry	addFileEntry(long userId, long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String description, String changeLog, File file, ServiceContext serviceContext) Adds a file entry and associated metadata based on a File object.
FileEntry	addFileEntry(long userId, long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String description, String changeLog, InputStream is, long size, ServiceContext serviceContext) Adds a file entry and associated metadata based on an InputStream object.
DLFileRank	addFileRank(long repositoryId, long companyId, long userId, long fileEntryId, ServiceContext serviceContext) Adds the file rank to the existing file entry.
DLFileShortcut	addFileShortcut(long userId, long repositoryId, long folderId, long toFileEntryId, ServiceContext serviceContext) Adds the file shortcut to the existing file entry.
Folder	addFolder(long userId, long repositoryId, long parentFolderId, String name, String description, ServiceContext serviceContext) Adds a folder.
void	deleteAll(long repositoryId) Delete all data associated to the given repository.
void	deleteFileEntry(long fileEntryId) Deletes the file entry.
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(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.
String	getBeanIdentifier() Returns the Spring bean ID for this bean.
List<FileEntry>	getFileEntries(long repositoryId, long folderId) Returns the file entries in the folder.
List<FileEntry>	getFileEntries(long repositoryId, long folderId, int start, int end) Returns a range of all the file entries in the folder.
List<FileEntry>	getFileEntries(long repositoryId, long folderId, int start, int end, OrderByComparator obc) Returns an ordered range of all the file entries in the folder.
List<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.
FileEntry	getFileEntry(long fileEntryId) Returns the file entry with the primary key.
FileEntry	getFileEntry(long groupId, long folderId, String title) Returns the file entry with the title in the folder.
FileEntry	getFileEntryByUuidAndGroupId(String uuid, long groupId) Returns the file entry with the UUID and group.
List<DLFileRank>	getFileRanks(long repositoryId, long userId) Returns the file ranks from the user.
DLFileShortcut	getFileShortcut(long fileShortcutId) Returns the file shortcut with the primary key.
FileVersion	getFileVersion(long fileVersionId) Returns the file version with the primary key.
Folder	getFolder(long folderId) Returns the folder with the primary key.
Folder	getFolder(long repositoryId, long parentFolderId, String name) Returns the folder with the name in the parent folder.
List<Folder>	getFolders(long repositoryId, long parentFolderId) Returns all immediate subfolders of the parent folder.
List<Folder>	getFolders(long repositoryId, long parentFolderId, boolean includeMountFolders) Returns all immediate subfolders of the parent folder, optionally including mount folders for third-party repositories.
List<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.
List<Folder>	getFolders(long repositoryId, long parentFolderId, boolean includeMountFolders, int start, int end, OrderByComparator obc) Returns an ordered range of all the immediate subfolders of the parent folder.
List<Folder>	getFolders(long repositoryId, long parentFolderId, int start, int end) Returns a range of all the immediate subfolders of the parent folder.
List<Folder>	getFolders(long repositoryId, long parentFolderId, int start, int end, OrderByComparator obc) Returns an ordered range of all the immediate subfolders of the parent folder.
List<Object>	getFoldersAndFileEntriesAndFileShortcuts(long repositoryId, long folderId, int status, boolean includeMountFolders, int start, int end, OrderByComparator obc) Returns an ordered range of all the immediate subfolders, file entries, and file shortcuts in the parent folder.
List<Object>	getFoldersAndFileEntriesAndFileShortcuts(long repositoryId, long folderId, int status, String[] mimeTypes, boolean includeMountFolders, int start, int end, 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, 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, List<Long> folderIds, int status) Returns the number of immediate subfolders and file entries across the folders.
Folder	getMountFolder(long repositoryId) Returns the mount folder of the repository with the primary key.
List<Folder>	getMountFolders(long repositoryId, long parentFolderId) Returns all immediate subfolders of the parent folder that are used for mounting third-party repositories.
List<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.
List<Folder>	getMountFolders(long repositoryId, long parentFolderId, int start, int end, 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.
DLAppLocalService	getWrappedDLAppLocalService() Deprecated. Renamed to getWrappedService()
DLAppLocalService	getWrappedService()
FileEntry	moveFileEntry(long userId, long fileEntryId, long newFolderId, ServiceContext serviceContext) Moves the file entry to the new folder.
void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
void	setWrappedDLAppLocalService(DLAppLocalService dlAppLocalService) Deprecated. Renamed to setWrappedService(com.liferay.portlet.documentlibrary.service.DLAppLocalService)
void	setWrappedService(DLAppLocalService dlAppLocalService)
void	updateAsset(long userId, FileEntry fileEntry, FileVersion fileVersion, long[] assetCategoryIds, String[] assetTagNames, long[] assetLinkEntryIds) Updates the file entry's asset replacing its asset categories, tags, and links.
FileEntry	updateFileEntry(long userId, long fileEntryId, String sourceFileName, String mimeType, String title, String description, String changeLog, boolean majorVersion, byte[] bytes, ServiceContext serviceContext) Updates a file entry and associated metadata based on a byte array object.
FileEntry	updateFileEntry(long userId, long fileEntryId, String sourceFileName, String mimeType, String title, String description, String changeLog, boolean majorVersion, File file, ServiceContext serviceContext) Updates a file entry and associated metadata based on a File object.
FileEntry	updateFileEntry(long userId, long fileEntryId, String sourceFileName, String mimeType, String title, String description, String changeLog, boolean majorVersion, InputStream is, long size, ServiceContext serviceContext) Updates a file entry and associated metadata based on an InputStream object.
DLFileRank	updateFileRank(long repositoryId, long companyId, long userId, long fileEntryId, ServiceContext serviceContext) Updates a file rank to the existing file entry.
DLFileShortcut	updateFileShortcut(long userId, long fileShortcutId, long folderId, long toFileEntryId, 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.
Folder	updateFolder(long folderId, long parentFolderId, String name, String description, ServiceContext serviceContext) Updates the folder.

Methods inherited from class java.lang.Object

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

Constructor Detail

DLAppLocalServiceWrapper

public DLAppLocalServiceWrapper(DLAppLocalService dlAppLocalService)

Method Detail

getBeanIdentifier

public String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Specified by:

getBeanIdentifier in interface DLAppLocalService

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Specified by:

setBeanIdentifier in interface DLAppLocalService

Parameters:

beanIdentifier - the Spring bean ID for this bean

addFileEntry

public FileEntry addFileEntry(long userId,
                              long repositoryId,
                              long folderId,
                              String sourceFileName,
                              String mimeType,
                              String title,
                              String description,
                              String changeLog,
                              byte[] bytes,
                              ServiceContext serviceContext)
                       throws PortalException,
                              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.

Specified by:

addFileEntry in interface DLAppLocalService

Parameters:

userId - the primary key of the file entry's creator/owner

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

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

sourceFileName - the original file's name

mimeType - the file's MIME type

title - the name to be assigned to the file (optionally null )

description - the file's description

changeLog - the file's version change log

bytes - the file's data (optionally null)

serviceContext - the service context to be applied. Can set the asset category IDs, asset tag names, and expando bridge attributes for the file entry. In a Liferay repository, it may include:

• fileEntryTypeId - ID for a custom file entry type
• fieldsMap - mapping for fields associated with a custom file entry type

Returns:

the file entry

Throws:

PortalException - if the parent folder could not be found or if the file entry's information was invalid

SystemException - if a system exception occurred

addFileEntry

public FileEntry addFileEntry(long userId,
                              long repositoryId,
                              long folderId,
                              String sourceFileName,
                              String mimeType,
                              String title,
                              String description,
                              String changeLog,
                              File file,
                              ServiceContext serviceContext)
                       throws PortalException,
                              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.

Specified by:

addFileEntry in interface DLAppLocalService

Parameters:

userId - the primary key of the file entry's creator/owner

repositoryId - the primary key of the repository

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

sourceFileName - the original file's name

mimeType - the file's MIME type

title - the name to be assigned to the file (optionally null )

description - the file's description

changeLog - the file's version change log

file - the file's data (optionally null)

serviceContext - the service context to be applied. Can set the asset category IDs, asset tag names, and expando bridge attributes for the file entry. In a Liferay repository, it may include:

• fileEntryTypeId - ID for a custom file entry type
• fieldsMap - mapping for fields associated with a custom file entry type

Returns:

the file entry

Throws:

PortalException - if the parent folder could not be found or if the file entry's information was invalid

SystemException - if a system exception occurred

addFileEntry

public FileEntry addFileEntry(long userId,
                              long repositoryId,
                              long folderId,
                              String sourceFileName,
                              String mimeType,
                              String title,
                              String description,
                              String changeLog,
                              InputStream is,
                              long size,
                              ServiceContext serviceContext)
                       throws PortalException,
                              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.

Specified by:

addFileEntry in interface DLAppLocalService

Parameters:

userId - the primary key of the file entry's creator/owner

repositoryId - the primary key of the repository

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

sourceFileName - the original file's name

mimeType - the file's MIME type

title - the name to be assigned to the file (optionally null )

description - the file's description

changeLog - the file's version change log

is - the file's data (optionally null)

size - the file's size (optionally 0)

serviceContext - the service context to be applied. Can set the asset category IDs, asset tag names, and expando bridge attributes for the file entry. In a Liferay repository, it may include:

• fileEntryTypeId - ID for a custom file entry type
• fieldsMap - mapping for fields associated with a custom file entry type

Returns:

the file entry

Throws:

PortalException - if the parent folder could not be found or if the file entry's information was invalid

SystemException - if a system exception occurred

addFileRank

public DLFileRank addFileRank(long repositoryId,
                              long companyId,
                              long userId,
                              long fileEntryId,
                              ServiceContext serviceContext)
                       throws SystemException

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

Specified by:

addFileRank in interface DLAppLocalService

Parameters:

repositoryId - the primary key of the repository

companyId - the primary key of the company

userId - the primary key of the file rank's creator/owner

fileEntryId - the primary key of the file entry

serviceContext - the service context to be applied

Returns:

the file rank

Throws:

SystemException - if a system exception occurred

addFileShortcut

public DLFileShortcut addFileShortcut(long userId,
                                      long repositoryId,
                                      long folderId,
                                      long toFileEntryId,
                                      ServiceContext serviceContext)
                               throws PortalException,
                                      SystemException

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

Specified by:

addFileShortcut in interface DLAppLocalService

Parameters:

userId - the primary key of the file shortcut's creator/owner

repositoryId - the primary key of the repository

folderId - the primary key of the file shortcut's parent folder

toFileEntryId - the primary key of the file entry to point to

serviceContext - the service context to be applied. Can set the asset category IDs, asset tag names, and expando bridge attributes for the file entry.

Returns:

the file shortcut

Throws:

PortalException - if the parent folder or file entry could not be found, or if the file shortcut's information was invalid

SystemException - if a system exception occurred

addFolder

public Folder addFolder(long userId,
                        long repositoryId,
                        long parentFolderId,
                        String name,
                        String description,
                        ServiceContext serviceContext)
                 throws PortalException,
                        SystemException

Adds a folder.

Specified by:

addFolder in interface DLAppLocalService

Parameters:

userId - the primary key of the folder's creator/owner

repositoryId - the primary key of the repository

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

name - the folder's name

description - the folder's description

serviceContext - the service context to be applied. In a Liferay repository, it may include mountPoint which is a boolean specifying whether the folder is a facade for mounting a third-party repository

Returns:

the folder

Throws:

PortalException - if the parent folder could not be found or if the new folder's information was invalid

SystemException - if a system exception occurred

deleteAll

public void deleteAll(long repositoryId)
               throws PortalException,
                      SystemException

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

Specified by:

deleteAll in interface DLAppLocalService

Parameters:

repositoryId - the primary key of the data's repository

Throws:

PortalException - if the repository could not be found

SystemException - if a system exception occurred

deleteFileEntry

public void deleteFileEntry(long fileEntryId)
                     throws PortalException,
                            SystemException

Deletes the file entry.

Specified by:

deleteFileEntry in interface DLAppLocalService

Parameters:

fileEntryId - the primary key of the file entry

Throws:

PortalException - if the file entry could not be found

SystemException - if a system exception occurred

deleteFileRanksByFileEntryId

public void deleteFileRanksByFileEntryId(long fileEntryId)
                                  throws SystemException

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

Specified by:

deleteFileRanksByFileEntryId in interface DLAppLocalService

Parameters:

fileEntryId - the primary key of the file entry

Throws:

SystemException - if a system exception occurred

deleteFileRanksByUserId

public void deleteFileRanksByUserId(long userId)
                             throws SystemException

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

Specified by:

deleteFileRanksByUserId in interface DLAppLocalService

Parameters:

userId - the primary key of the user

Throws:

SystemException - if a system exception occurred

deleteFileShortcut

public void deleteFileShortcut(DLFileShortcut dlFileShortcut)
                        throws PortalException,
                               SystemException

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

Specified by:

deleteFileShortcut in interface DLAppLocalService

Parameters:

dlFileShortcut - the file shortcut

Throws:

PortalException - if the file shortcut could not be found

SystemException - if a system exception occurred

deleteFileShortcut

public void deleteFileShortcut(long fileShortcutId)
                        throws PortalException,
                               SystemException

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

Specified by:

deleteFileShortcut in interface DLAppLocalService

Parameters:

fileShortcutId - the primary key of the file shortcut

Throws:

PortalException - if the file shortcut could not be found

SystemException - if a system exception occurred

deleteFileShortcuts

public void deleteFileShortcuts(long toFileEntryId)
                         throws PortalException,
                                SystemException

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

Specified by:

deleteFileShortcuts in interface DLAppLocalService

Parameters:

toFileEntryId - the primary key of the associated file entry

Throws:

PortalException - if the file shortcut for the file entry could not be found

SystemException - if a system exception occurred

deleteFolder

public void deleteFolder(long folderId)
                  throws PortalException,
                         SystemException

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

Specified by:

deleteFolder in interface DLAppLocalService

Parameters:

folderId - the primary key of the folder

Throws:

PortalException - if the folder could not be found

SystemException - if a system exception occurred

getFileEntries

public List<FileEntry> getFileEntries(long repositoryId,
                                      long folderId)
                               throws PortalException,
                                      SystemException

Returns the file entries in the folder.

Specified by:

getFileEntries in interface DLAppLocalService

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:

PortalException - if the folder could not be found

SystemException - if a system exception occurred

getFileEntries

public List<FileEntry> getFileEntries(long repositoryId,
                                      long folderId,
                                      int start,
                                      int end)
                               throws PortalException,
                                      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.

Specified by:

getFileEntries in interface DLAppLocalService

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:

PortalException - if the folder could not be found

SystemException - if a system exception occurred

getFileEntries

public List<FileEntry> getFileEntries(long repositoryId,
                                      long folderId,
                                      int start,
                                      int end,
                                      OrderByComparator obc)
                               throws PortalException,
                                      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.

Specified by:

getFileEntries in interface DLAppLocalService

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:

PortalException - if the folder could not be found

SystemException - if a system exception occurred

getFileEntriesAndFileShortcuts

public List<Object> getFileEntriesAndFileShortcuts(long repositoryId,
                                                   long folderId,
                                                   int status,
                                                   int start,
                                                   int end)
                                            throws PortalException,
                                                   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.

Specified by:

getFileEntriesAndFileShortcuts in interface DLAppLocalService

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:

PortalException - if the folder could not be found

SystemException - if a system exception occurred

getFileEntriesAndFileShortcutsCount

public int getFileEntriesAndFileShortcutsCount(long repositoryId,
                                               long folderId,
                                               int status)
                                        throws PortalException,
                                               SystemException

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

Specified by:

getFileEntriesAndFileShortcutsCount in interface DLAppLocalService

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:

PortalException - if the folder could not be found

SystemException - if a system exception occurred

getFileEntriesCount

public int getFileEntriesCount(long repositoryId,
                               long folderId)
                        throws PortalException,
                               SystemException

Returns the number of file entries in the folder.

Specified by:

getFileEntriesCount in interface DLAppLocalService

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:

PortalException - if the folder could not be found

SystemException - if a system exception occurred

getFileEntry

public FileEntry getFileEntry(long fileEntryId)
                       throws PortalException,
                              SystemException

Returns the file entry with the primary key.

Specified by:

getFileEntry in interface DLAppLocalService

Parameters:

fileEntryId - the primary key of the file entry

Returns:

the file entry with the primary key

Throws:

PortalException - if the file entry could not be found

SystemException - if a system exception occurred

getFileEntry

public FileEntry getFileEntry(long groupId,
                              long folderId,
                              String title)
                       throws PortalException,
                              SystemException

Returns the file entry with the title in the folder.

Specified by:

getFileEntry in interface DLAppLocalService

Parameters:

groupId - the primary key of the file entry's group

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

title - the file entry's title

Returns:

the file entry with the title in the folder

Throws:

PortalException - if the file entry could not be found

SystemException - if a system exception occurred

getFileEntryByUuidAndGroupId

public FileEntry getFileEntryByUuidAndGroupId(String uuid,
                                              long groupId)
                                       throws PortalException,
                                              SystemException

Returns the file entry with the UUID and group.

Specified by:

getFileEntryByUuidAndGroupId in interface DLAppLocalService

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:

PortalException - if the file entry could not be found

SystemException - if a system exception occurred

getFileRanks

public List<DLFileRank> getFileRanks(long repositoryId,
                                     long userId)
                              throws SystemException

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

Specified by:

getFileRanks in interface DLAppLocalService

Parameters:

repositoryId - the primary key of the repository

userId - the primary key of the user

Returns:

the file ranks from the user

Throws:

SystemException - if a system exception occurred

getFileShortcut

public DLFileShortcut getFileShortcut(long fileShortcutId)
                               throws PortalException,
                                      SystemException

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

Specified by:

getFileShortcut in interface DLAppLocalService

Parameters:

fileShortcutId - the primary key of the file shortcut

Returns:

the file shortcut with the primary key

Throws:

PortalException - if the file shortcut could not be found

SystemException - if a system exception occurred

getFileVersion

public FileVersion getFileVersion(long fileVersionId)
                           throws PortalException,
                                  SystemException

Returns the file version with the primary key.

Specified by:

getFileVersion in interface DLAppLocalService

Parameters:

fileVersionId - the primary key of the file version

Returns:

the file version with the primary key

Throws:

PortalException - if the file version could not be found

SystemException - if a system exception occurred

getFolder

public Folder getFolder(long folderId)
                 throws PortalException,
                        SystemException

Returns the folder with the primary key.

Specified by:

getFolder in interface DLAppLocalService

Parameters:

folderId - the primary key of the folder

Returns:

the folder with the primary key

Throws:

PortalException - if the folder could not be found

SystemException - if a system exception occurred

getFolder

public Folder getFolder(long repositoryId,
                        long parentFolderId,
                        String name)
                 throws PortalException,
                        SystemException

Returns the folder with the name in the parent folder.

Specified by:

getFolder in interface DLAppLocalService

Parameters:

repositoryId - the primary key of the folder's repository

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

name - the folder's name

Returns:

the folder with the name in the parent folder

Throws:

PortalException - if the folder could not be found

SystemException - if a system exception occurred

getFolders

public List<Folder> getFolders(long repositoryId,
                               long parentFolderId)
                        throws PortalException,
                               SystemException

Returns all immediate subfolders of the parent folder.

Specified by:

getFolders in interface DLAppLocalService

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:

PortalException - if the parent folder could not be found

SystemException - if a system exception occurred

getFolders

public List<Folder> getFolders(long repositoryId,
                               long parentFolderId,
                               boolean includeMountFolders)
                        throws PortalException,
                               SystemException

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

Specified by:

getFolders in interface DLAppLocalService

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:

PortalException - if the parent folder could not be found

SystemException - if a system exception occurred

getFolders

public List<Folder> getFolders(long repositoryId,
                               long parentFolderId,
                               boolean includeMountFolders,
                               int start,
                               int end)
                        throws PortalException,
                               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.

Specified by:

getFolders in interface DLAppLocalService

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:

PortalException - if the parent folder could not be found

SystemException - if a system exception occurred

getFolders

public List<Folder> getFolders(long repositoryId,
                               long parentFolderId,
                               boolean includeMountFolders,
                               int start,
                               int end,
                               OrderByComparator obc)
                        throws PortalException,
                               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.

Specified by:

getFolders in interface DLAppLocalService

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:

PortalException - if the parent folder could not be found

SystemException - if a system exception occurred

getFolders

public List<Folder> getFolders(long repositoryId,
                               long parentFolderId,
                               int start,
                               int end)
                        throws PortalException,
                               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.

Specified by:

getFolders in interface DLAppLocalService

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:

PortalException - if the parent folder could not be found

SystemException - if a system exception occurred

getFolders

public List<Folder> getFolders(long repositoryId,
                               long parentFolderId,
                               int start,
                               int end,
                               OrderByComparator obc)
                        throws PortalException,
                               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.

Specified by:

getFolders in interface DLAppLocalService

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:

PortalException - if the parent folder could not be found

SystemException - if a system exception occurred

getFoldersAndFileEntriesAndFileShortcuts

public List<Object> getFoldersAndFileEntriesAndFileShortcuts(long repositoryId,
                                                             long folderId,
                                                             int status,
                                                             boolean includeMountFolders,
                                                             int start,
                                                             int end,
                                                             OrderByComparator obc)
                                                      throws PortalException,
                                                             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.

Specified by:

getFoldersAndFileEntriesAndFileShortcuts in interface DLAppLocalService

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:

PortalException - if the folder could not be found

SystemException - if a system exception occurred

getFoldersAndFileEntriesAndFileShortcuts

public List<Object> getFoldersAndFileEntriesAndFileShortcuts(long repositoryId,
                                                             long folderId,
                                                             int status,
                                                             String[] mimeTypes,
                                                             boolean includeMountFolders,
                                                             int start,
                                                             int end,
                                                             OrderByComparator obc)
                                                      throws PortalException,
                                                             SystemException

Specified by:

getFoldersAndFileEntriesAndFileShortcuts in interface DLAppLocalService

Throws:

PortalException

SystemException

getFoldersAndFileEntriesAndFileShortcutsCount

public int getFoldersAndFileEntriesAndFileShortcutsCount(long repositoryId,
                                                         long folderId,
                                                         int status,
                                                         boolean includeMountFolders)
                                                  throws PortalException,
                                                         SystemException

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

Specified by:

getFoldersAndFileEntriesAndFileShortcutsCount in interface DLAppLocalService

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:

PortalException - if the folder could not be found

SystemException - if a system exception occurred

getFoldersAndFileEntriesAndFileShortcutsCount

public int getFoldersAndFileEntriesAndFileShortcutsCount(long repositoryId,
                                                         long folderId,
                                                         int status,
                                                         String[] mimeTypes,
                                                         boolean includeMountFolders)
                                                  throws PortalException,
                                                         SystemException

Specified by:

getFoldersAndFileEntriesAndFileShortcutsCount in interface DLAppLocalService

Throws:

PortalException

SystemException

getFoldersCount

public int getFoldersCount(long repositoryId,
                           long parentFolderId)
                    throws PortalException,
                           SystemException

Returns the number of immediate subfolders of the parent folder.

Specified by:

getFoldersCount in interface DLAppLocalService

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:

PortalException - if the parent folder could not be found

SystemException - if a system exception occurred

getFoldersCount

public int getFoldersCount(long repositoryId,
                           long parentFolderId,
                           boolean includeMountFolders)
                    throws PortalException,
                           SystemException

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

Specified by:

getFoldersCount in interface DLAppLocalService

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:

PortalException - if the parent folder could not be found

SystemException - if a system exception occurred

getFoldersFileEntriesCount

public int getFoldersFileEntriesCount(long repositoryId,
                                      List<Long> folderIds,
                                      int status)
                               throws PortalException,
                                      SystemException

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

Specified by:

getFoldersFileEntriesCount in interface DLAppLocalService

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:

PortalException - if the repository could not be found

SystemException - if a system exception occurred

getMountFolder

public Folder getMountFolder(long repositoryId)
                      throws PortalException,
                             SystemException

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

Specified by:

getMountFolder in interface DLAppLocalService

Parameters:

repositoryId - the primary key of the repository

Returns:

the folder used for mounting third-party repositories

Throws:

PortalException - if the repository or mount folder could not be found

SystemException - if a system exception occurred

getMountFolders

public List<Folder> getMountFolders(long repositoryId,
                                    long parentFolderId)
                             throws PortalException,
                                    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.

Specified by:

getMountFolders in interface DLAppLocalService

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:

PortalException - if the repository or parent folder could not be found

SystemException - if a system exception occurred

getMountFolders

public List<Folder> getMountFolders(long repositoryId,
                                    long parentFolderId,
                                    int start,
                                    int end)
                             throws PortalException,
                                    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.

Specified by:

getMountFolders in interface DLAppLocalService

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:

PortalException - if the repository or parent folder could not be found

SystemException - if a system exception occurred

getMountFolders

public List<Folder> getMountFolders(long repositoryId,
                                    long parentFolderId,
                                    int start,
                                    int end,
                                    OrderByComparator obc)
                             throws PortalException,
                                    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.

Specified by:

getMountFolders in interface DLAppLocalService

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:

PortalException - if the repository or parent folder could not be found

SystemException - if a system exception occurred

getMountFoldersCount

public int getMountFoldersCount(long repositoryId,
                                long parentFolderId)
                         throws PortalException,
                                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.

Specified by:

getMountFoldersCount in interface DLAppLocalService

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:

PortalException - if the repository or parent folder could not be found

SystemException - if a system exception occurred

moveFileEntry

public FileEntry moveFileEntry(long userId,
                               long fileEntryId,
                               long newFolderId,
                               ServiceContext serviceContext)
                        throws PortalException,
                               SystemException

Moves the file entry to the new folder.

Specified by:

moveFileEntry in interface DLAppLocalService

Parameters:

userId - the primary key of the user

fileEntryId - the primary key of the file entry

newFolderId - the primary key of the new folder

serviceContext - the service context to be applied

Returns:

the file entry

Throws:

PortalException - if the file entry or the new folder could not be found

SystemException - if a system exception occurred

updateAsset

public void updateAsset(long userId,
                        FileEntry fileEntry,
                        FileVersion fileVersion,
                        long[] assetCategoryIds,
                        String[] assetTagNames,
                        long[] assetLinkEntryIds)
                 throws PortalException,
                        SystemException

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

Specified by:

updateAsset in interface DLAppLocalService

Parameters:

userId - the primary key of the user

fileEntry - the file entry to update

fileVersion - the file version to update

assetCategoryIds - the primary keys of the new asset categories

assetTagNames - the new asset tag names

assetLinkEntryIds - the primary keys of the new asset link entries

Throws:

PortalException - if the file entry or version could not be found

SystemException - if a system exception occurred

updateFileEntry

public FileEntry updateFileEntry(long userId,
                                 long fileEntryId,
                                 String sourceFileName,
                                 String mimeType,
                                 String title,
                                 String description,
                                 String changeLog,
                                 boolean majorVersion,
                                 byte[] bytes,
                                 ServiceContext serviceContext)
                          throws PortalException,
                                 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.

Specified by:

updateFileEntry in interface DLAppLocalService

Parameters:

userId - the primary key of the user

fileEntryId - the primary key of the file entry

sourceFileName - the original file's name (optionally null)

mimeType - the file's MIME type (optionally null)

title - the new name to be assigned to the file (optionally null)

description - the file's new description

changeLog - the file's version change log (optionally null)

majorVersion - whether the new file version is a major version

bytes - the file's data (optionally null)

serviceContext - the service context to be applied. Can set the asset category IDs, asset tag names, and expando bridge attributes for the file entry. In a Liferay repository, it may include:

• fileEntryTypeId - ID for a custom file entry type
• fieldsMap - mapping for fields associated with a custom file entry type

Returns:

the file entry

Throws:

PortalException - if the file entry could not be found

SystemException - if a system exception occurred

updateFileEntry

public FileEntry updateFileEntry(long userId,
                                 long fileEntryId,
                                 String sourceFileName,
                                 String mimeType,
                                 String title,
                                 String description,
                                 String changeLog,
                                 boolean majorVersion,
                                 File file,
                                 ServiceContext serviceContext)
                          throws PortalException,
                                 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.

Specified by:

updateFileEntry in interface DLAppLocalService

Parameters:

userId - the primary key of the user

fileEntryId - the primary key of the file entry

sourceFileName - the original file's name (optionally null)

mimeType - the file's MIME type (optionally null)

title - the new name to be assigned to the file (optionally null)

description - the file's new description

changeLog - the file's version change log (optionally null)

majorVersion - whether the new file version is a major version

file - 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:

PortalException - if the file entry could not be found

SystemException - if a system exception occurred

updateFileEntry

public FileEntry updateFileEntry(long userId,
                                 long fileEntryId,
                                 String sourceFileName,
                                 String mimeType,
                                 String title,
                                 String description,
                                 String changeLog,
                                 boolean majorVersion,
                                 InputStream is,
                                 long size,
                                 ServiceContext serviceContext)
                          throws PortalException,
                                 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.

Specified by:

updateFileEntry in interface DLAppLocalService

Parameters:

userId - the primary key of the user

fileEntryId - the primary key of the file entry

sourceFileName - the original file's name (optionally null)

mimeType - the file's MIME type (optionally null)

title - the new name to be assigned to the file (optionally null)

description - the file's new description

changeLog - the file's version change log (optionally null)

majorVersion - whether the new file version is a major version

is - the file's data (optionally null)

size - the file's size (optionally 0)

serviceContext - the service context to be applied. Can set the asset category IDs, asset tag names, and expando bridge attributes for the file entry. In a Liferay repository, it may include:

• fileEntryTypeId - ID for a custom file entry type
• fieldsMap - mapping for fields associated with a custom file entry type

Returns:

the file entry

Throws:

PortalException - if the file entry could not be found

SystemException - if a system exception occurred

updateFileRank

public DLFileRank updateFileRank(long repositoryId,
                                 long companyId,
                                 long userId,
                                 long fileEntryId,
                                 ServiceContext serviceContext)
                          throws SystemException

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

Specified by:

updateFileRank in interface DLAppLocalService

Parameters:

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

companyId - the primary key of the file rank's company

userId - the primary key of the file rank's creator/owner

fileEntryId - the primary key of the file rank's file entry

serviceContext - the service context to be applied

Returns:

the file rank

Throws:

SystemException - if a system exception occurred

updateFileShortcut

public DLFileShortcut updateFileShortcut(long userId,
                                         long fileShortcutId,
                                         long folderId,
                                         long toFileEntryId,
                                         ServiceContext serviceContext)
                                  throws PortalException,
                                         SystemException

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

Specified by:

updateFileShortcut in interface DLAppLocalService

Parameters:

userId - the primary key of the file shortcut's creator/owner

fileShortcutId - the primary key of the file shortcut

folderId - the primary key of the file shortcut's parent folder

toFileEntryId - the primary key of the file shortcut's file entry

serviceContext - the service context to be applied. Can set the asset category IDs, asset tag names, and expando bridge attributes for the file entry.

Returns:

the file shortcut

Throws:

PortalException - if the file shortcut, folder, or file entry could not be found

SystemException - if a system exception occurred

updateFileShortcuts

public void updateFileShortcuts(long toRepositoryId,
                                long oldToFileEntryId,
                                long newToFileEntryId)
                         throws SystemException

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

Specified by:

updateFileShortcuts in interface DLAppLocalService

Parameters:

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:

SystemException - if a system exception occurred

updateFolder

public Folder updateFolder(long folderId,
                           long parentFolderId,
                           String name,
                           String description,
                           ServiceContext serviceContext)
                    throws PortalException,
                           SystemException

Updates the folder.

Specified by:

updateFolder in interface DLAppLocalService

Parameters:

folderId - the primary key of the folder

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

name - the folder's new name

description - the folder's new description

serviceContext - the service context to be applied. In a Liferay repository, it may include:

• defaultFileEntryTypeId - the file entry type to default all Liferay file entries to
• dlFileEntryTypesSearchContainerPrimaryKeys - a comma-delimited list of file entry type primary keys allowed in the given folder and all descendants
• 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:

PortalException - if the current or new parent folder could not be found, or if the new parent folder's information was invalid

SystemException - if a system exception occurred

getWrappedDLAppLocalService

public DLAppLocalService getWrappedDLAppLocalService()

Deprecated. Renamed to getWrappedService()

setWrappedDLAppLocalService

public void setWrappedDLAppLocalService(DLAppLocalService dlAppLocalService)

Deprecated. Renamed to setWrappedService(com.liferay.portlet.documentlibrary.service.DLAppLocalService)

getWrappedService

public DLAppLocalService getWrappedService()

Specified by:

getWrappedService in interface ServiceWrapper<DLAppLocalService>

setWrappedService

public void setWrappedService(DLAppLocalService dlAppLocalService)

Specified by:

setWrappedService in interface ServiceWrapper<DLAppLocalService>