|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.portal.service.BaseLocalServiceImpl
com.liferay.portlet.documentlibrary.service.base.DLAppLocalServiceBaseImpl
com.liferay.portlet.documentlibrary.service.impl.DLAppLocalServiceImpl
public class DLAppLocalServiceImpl
Provides the local service for accessing, adding, deleting, moving, subscription handling of, and updating document library file entries, file ranks, and folders. All portlets should interact with the document library through this class or through DLAppService, rather than through the individual document library service classes.
This class provides a unified interface to all Liferay and third party repositories. While the method signatures are universal for all repositories. Additional implementation-specific parameters may be specified in the serviceContext.
The repositoryId parameter used by most of the methods is the
primary key of the specific repository. If the repository is a default
Liferay repository, the repositoryId is the groupId
or scopeGroupId. Otherwise, the repositoryId will
correspond to values obtained from RepositoryLocalServiceUtil.
DLAppServiceImpl| Field Summary | |
|---|---|
protected RepositoryProvider |
repositoryProvider
|
| Constructor Summary | |
|---|---|
DLAppLocalServiceImpl()
|
|
| Method Summary | |
|---|---|
FileEntry |
addFileEntry(long userId,
long repositoryId,
long folderId,
String sourceFileName,
String mimeType,
byte[] bytes,
ServiceContext serviceContext)
|
FileEntry |
addFileEntry(long userId,
long repositoryId,
long folderId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
byte[] bytes,
ServiceContext serviceContext)
Adds a file entry and associated metadata based on a byte array. |
FileEntry |
addFileEntry(long userId,
long repositoryId,
long folderId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
File file,
ServiceContext serviceContext)
Adds a file entry and associated metadata based on a File object. |
FileEntry |
addFileEntry(long userId,
long repositoryId,
long folderId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
InputStream is,
long size,
ServiceContext serviceContext)
Adds a file entry and associated metadata based on an InputStream
object. |
DLFileRank |
addFileRank(long repositoryId,
long companyId,
long userId,
long fileEntryId,
ServiceContext serviceContext)
Adds the file rank to the existing file entry. |
FileShortcut |
addFileShortcut(long userId,
long repositoryId,
long folderId,
long toFileEntryId,
ServiceContext serviceContext)
Adds the file shortcut to the existing file entry. |
Folder |
addFolder(long userId,
long repositoryId,
long parentFolderId,
String name,
String description,
ServiceContext serviceContext)
Adds a folder. |
protected FileEntry |
copyFileEntry(long userId,
LocalRepository toLocalRepository,
FileEntry fileEntry,
long newFolderId,
ServiceContext serviceContext)
|
protected Folder |
copyFolder(long userId,
long folderId,
long parentFolderId,
LocalRepository fromLocalRepository,
LocalRepository toLocalRepository,
ServiceContext serviceContext)
|
protected void |
copyFolderDependencies(long userId,
Folder sourceFolder,
Folder destinationFolder,
LocalRepository fromLocalRepository,
LocalRepository toLocalRepository,
ServiceContext serviceContext)
|
void |
deleteAll(long repositoryId)
Delete all data associated to the given repository. |
void |
deleteAllRepositories(long groupId)
|
void |
deleteFileEntry(long fileEntryId)
Deletes the file entry. |
protected void |
deleteFileEntry(long oldFileEntryId,
long newFileEntryId,
LocalRepository fromLocalRepository,
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(FileShortcut fileShortcut)
Deletes the file shortcut. |
void |
deleteFileShortcut(long fileShortcutId)
Deletes the file shortcut. |
void |
deleteFileShortcuts(long toFileEntryId)
Deletes all file shortcuts associated to the file entry. |
void |
deleteFolder(long folderId)
Deletes the folder and all of its subfolders and file entries. |
protected void |
deleteRepository(LocalRepository localRepository)
|
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. |
FileShortcut |
getFileShortcut(long fileShortcutId)
Returns the file shortcut with the primary key. |
FileVersion |
getFileVersion(long fileVersionId)
Returns the file version with the primary key. |
Folder |
getFolder(long folderId)
Returns the folder with the primary key. |
Folder |
getFolder(long repositoryId,
long parentFolderId,
String name)
Returns the folder with the name in the parent folder. |
protected LocalRepository |
getFolderLocalRepository(long folderId,
long groupId)
|
protected LocalRepository |
getLocalRepository(long repositoryId)
|
Folder |
getMountFolder(long repositoryId)
Returns the mount folder of the repository with the primary key. |
protected FileEntry |
moveFileEntry(long userId,
long fileEntryId,
long newFolderId,
LocalRepository fromLocalRepository,
LocalRepository toLocalRepository,
ServiceContext serviceContext)
|
FileEntry |
moveFileEntry(long userId,
long fileEntryId,
long newFolderId,
ServiceContext serviceContext)
Moves the file entry to the new folder. |
protected Folder |
moveFolder(long userId,
long folderId,
long parentFolderId,
LocalRepository fromLocalRepository,
LocalRepository toLocalRepository,
ServiceContext serviceContext)
|
Folder |
moveFolder(long userId,
long folderId,
long parentFolderId,
ServiceContext serviceContext)
|
void |
subscribeFileEntryType(long userId,
long groupId,
long fileEntryTypeId)
Subscribe the user to changes in documents of the file entry type. |
void |
subscribeFolder(long userId,
long groupId,
long folderId)
Subscribe the user to document changes in the folder. |
void |
unsubscribeFileEntryType(long userId,
long groupId,
long fileEntryTypeId)
Unsubscribe the user from changes in documents of the file entry type. |
void |
unsubscribeFolder(long userId,
long groupId,
long folderId)
Unsubscribe the user from document changes in the folder. |
void |
updateAsset(long userId,
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. |
FileShortcut |
updateFileShortcut(long userId,
long fileShortcutId,
long folderId,
long toFileEntryId,
ServiceContext serviceContext)
Updates a file shortcut to the existing file entry. |
void |
updateFileShortcuts(long oldToFileEntryId,
long newToFileEntryId)
Updates all file shortcuts to the existing file entry to the new file entry. |
void |
updateFileShortcuts(long toRepositoryId,
long oldToFileEntryId,
long newToFileEntryId)
Deprecated. |
Folder |
updateFolder(long folderId,
long parentFolderId,
String name,
String description,
ServiceContext serviceContext)
Updates the folder. |
| Methods inherited from class com.liferay.portal.service.BaseLocalServiceImpl |
|---|
getClassLoader, getLocalizationMap |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
@BeanReference(type=RepositoryProvider.class) protected RepositoryProvider repositoryProvider
| Constructor Detail |
|---|
public DLAppLocalServiceImpl()
| Method Detail |
|---|
public FileEntry addFileEntry(long userId,
long repositoryId,
long folderId,
String sourceFileName,
String mimeType,
byte[] bytes,
ServiceContext serviceContext)
throws PortalException
PortalException
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
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.
userId - the primary key of the file entry's creator/ownerrepositoryId - the primary key of the file entry's repositoryfolderId - the primary key of the file entry's parent foldersourceFileName - the original file's namemimeType - the file's MIME typetitle - the name to be assigned to the file (optionally null
)description - the file's descriptionchangeLog - the file's version change logbytes - 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: PortalException
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
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.
userId - the primary key of the file entry's creator/ownerrepositoryId - the primary key of the repositoryfolderId - the primary key of the file entry's parent foldersourceFileName - the original file's namemimeType - the file's MIME typetitle - the name to be assigned to the file (optionally null
)description - the file's descriptionchangeLog - the file's version change logfile - 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: PortalException
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
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.
userId - the primary key of the file entry's creator/ownerrepositoryId - the primary key of the repositoryfolderId - the primary key of the file entry's parent foldersourceFileName - the original file's namemimeType - the file's MIME typetitle - the name to be assigned to the file (optionally null
)description - the file's descriptionchangeLog - the file's version change logis - 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: PortalException
public DLFileRank addFileRank(long repositoryId,
long companyId,
long userId,
long fileEntryId,
ServiceContext serviceContext)
repositoryId - the primary key of the repositorycompanyId - the primary key of the companyuserId - the primary key of the file rank's creator/ownerfileEntryId - the primary key of the file entryserviceContext - the service context to be applied
public FileShortcut addFileShortcut(long userId,
long repositoryId,
long folderId,
long toFileEntryId,
ServiceContext serviceContext)
throws PortalException
userId - the primary key of the file shortcut's creator/ownerrepositoryId - the primary key of the repositoryfolderId - the primary key of the file shortcut's parent foldertoFileEntryId - the primary key of the file entry to point toserviceContext - the service context to be applied. Can set the
asset category IDs, asset tag names, and expando bridge
attributes for the file entry.
PortalException
public Folder addFolder(long userId,
long repositoryId,
long parentFolderId,
String name,
String description,
ServiceContext serviceContext)
throws PortalException
userId - the primary key of the folder's creator/ownerrepositoryId - the primary key of the repositoryparentFolderId - the primary key of the folder's parent foldername - the folder's namedescription - the folder's descriptionserviceContext - 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
PortalException
public void deleteAll(long repositoryId)
throws PortalException
repositoryId - the primary key of the data's repository
PortalException
public void deleteAllRepositories(long groupId)
throws PortalException
PortalException
public void deleteFileEntry(long fileEntryId)
throws PortalException
fileEntryId - the primary key of the file entry
PortalExceptionpublic void deleteFileRanksByFileEntryId(long fileEntryId)
fileEntryId - the primary key of the file entrypublic void deleteFileRanksByUserId(long userId)
userId - the primary key of the user
public void deleteFileShortcut(FileShortcut fileShortcut)
throws PortalException
fileShortcut - the file shortcut
PortalException
public void deleteFileShortcut(long fileShortcutId)
throws PortalException
fileShortcutId - the primary key of the file shortcut
PortalException
public void deleteFileShortcuts(long toFileEntryId)
throws PortalException
toFileEntryId - the primary key of the associated file entry
PortalException
public void deleteFolder(long folderId)
throws PortalException
folderId - the primary key of the folder
PortalException
public FileEntry getFileEntry(long fileEntryId)
throws PortalException
fileEntryId - the primary key of the file entry
PortalException
public FileEntry getFileEntry(long groupId,
long folderId,
String title)
throws PortalException
groupId - the primary key of the file entry's groupfolderId - the primary key of the file entry's foldertitle - the file entry's title
PortalException
public FileEntry getFileEntryByUuidAndGroupId(String uuid,
long groupId)
throws PortalException
uuid - the file entry's UUIDgroupId - the primary key of the file entry's group
PortalException
public List<DLFileRank> getFileRanks(long repositoryId,
long userId)
repositoryId - the primary key of the repositoryuserId - the primary key of the user
public FileShortcut getFileShortcut(long fileShortcutId)
throws PortalException
fileShortcutId - the primary key of the file shortcut
PortalException
public FileVersion getFileVersion(long fileVersionId)
throws PortalException
fileVersionId - the primary key of the file version
PortalException
public Folder getFolder(long folderId)
throws PortalException
folderId - the primary key of the folder
PortalException
public Folder getFolder(long repositoryId,
long parentFolderId,
String name)
throws PortalException
repositoryId - the primary key of the folder's repositoryparentFolderId - the primary key of the folder's parent foldername - the folder's name
PortalException
public Folder getMountFolder(long repositoryId)
throws PortalException
repositoryId - the primary key of the repository
PortalException
public FileEntry moveFileEntry(long userId,
long fileEntryId,
long newFolderId,
ServiceContext serviceContext)
throws PortalException
userId - the primary key of the userfileEntryId - the primary key of the file entrynewFolderId - the primary key of the new folderserviceContext - the service context to be applied
PortalException
public Folder moveFolder(long userId,
long folderId,
long parentFolderId,
ServiceContext serviceContext)
throws PortalException
PortalException
public void subscribeFileEntryType(long userId,
long groupId,
long fileEntryTypeId)
throws PortalException
userId - the primary key of the usergroupId - the primary key of the file entry type's groupfileEntryTypeId - the primary key of the file entry type
PortalException
public void subscribeFolder(long userId,
long groupId,
long folderId)
throws PortalException
userId - the primary key of the usergroupId - the primary key of the folder's groupfolderId - the primary key of the folder
PortalException
public void unsubscribeFileEntryType(long userId,
long groupId,
long fileEntryTypeId)
throws PortalException
userId - the primary key of the usergroupId - the primary key of the file entry type's groupfileEntryTypeId - the primary key of the file entry type
PortalException
public void unsubscribeFolder(long userId,
long groupId,
long folderId)
throws PortalException
userId - the primary key of the usergroupId - the primary key of the folder's groupfolderId - the primary key of the folder
PortalException
public void updateAsset(long userId,
FileEntry fileEntry,
FileVersion fileVersion,
long[] assetCategoryIds,
String[] assetTagNames,
long[] assetLinkEntryIds)
throws PortalException
userId - the primary key of the userfileEntry - the file entry to updatefileVersion - the file version to updateassetCategoryIds - the primary keys of the new asset categoriesassetTagNames - the new asset tag namesassetLinkEntryIds - the primary keys of the new asset link entries
PortalException
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
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.
userId - the primary key of the userfileEntryId - the primary key of the file entrysourceFileName - 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 descriptionchangeLog - the file's version change log (optionally
null)majorVersion - whether the new file version is a major versionbytes - 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: PortalException
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
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.
userId - the primary key of the userfileEntryId - the primary key of the file entrysourceFileName - 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 descriptionchangeLog - the file's version change log (optionally
null)majorVersion - whether the new file version is a major versionfile - 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: PortalException
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
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.
userId - the primary key of the userfileEntryId - the primary key of the file entrysourceFileName - 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 descriptionchangeLog - the file's version change log (optionally
null)majorVersion - whether the new file version is a major versionis - 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: PortalException
public DLFileRank updateFileRank(long repositoryId,
long companyId,
long userId,
long fileEntryId,
ServiceContext serviceContext)
repositoryId - the primary key of the file rank's repositorycompanyId - the primary key of the file rank's companyuserId - the primary key of the file rank's creator/ownerfileEntryId - the primary key of the file rank's file entryserviceContext - the service context to be applied
public FileShortcut updateFileShortcut(long userId,
long fileShortcutId,
long folderId,
long toFileEntryId,
ServiceContext serviceContext)
throws PortalException
userId - the primary key of the file shortcut's creator/ownerfileShortcutId - the primary key of the file shortcutfolderId - the primary key of the file shortcut's parent foldertoFileEntryId - the primary key of the file shortcut's file entryserviceContext - the service context to be applied. Can set the
asset category IDs, asset tag names, and expando bridge
attributes for the file entry.
PortalException
public void updateFileShortcuts(long oldToFileEntryId,
long newToFileEntryId)
throws PortalException
oldToFileEntryId - the primary key of the old file entry pointed tonewToFileEntryId - the primary key of the new file entry to point to
PortalException
@Deprecated
public void updateFileShortcuts(long toRepositoryId,
long oldToFileEntryId,
long newToFileEntryId)
throws PortalException
updateFileShortcuts(long,
long)
PortalException
public Folder updateFolder(long folderId,
long parentFolderId,
String name,
String description,
ServiceContext serviceContext)
throws PortalException
folderId - the primary key of the folderparentFolderId - the primary key of the folder's new parent foldername - the folder's new namedescription - the folder's new descriptionserviceContext - the service context to be applied. In a Liferay
repository, it may include: workflowDefinition appended by the
fileEntryTypeId (optionally 0).PortalException
protected FileEntry copyFileEntry(long userId,
LocalRepository toLocalRepository,
FileEntry fileEntry,
long newFolderId,
ServiceContext serviceContext)
throws PortalException
PortalException
protected Folder copyFolder(long userId,
long folderId,
long parentFolderId,
LocalRepository fromLocalRepository,
LocalRepository toLocalRepository,
ServiceContext serviceContext)
throws PortalException
PortalException
protected void copyFolderDependencies(long userId,
Folder sourceFolder,
Folder destinationFolder,
LocalRepository fromLocalRepository,
LocalRepository toLocalRepository,
ServiceContext serviceContext)
throws PortalException
PortalException
protected void deleteFileEntry(long oldFileEntryId,
long newFileEntryId,
LocalRepository fromLocalRepository,
LocalRepository toLocalRepository)
throws PortalException
PortalException
protected void deleteRepository(LocalRepository localRepository)
throws PortalException
PortalException
protected LocalRepository getFolderLocalRepository(long folderId,
long groupId)
throws PortalException
PortalException
protected LocalRepository getLocalRepository(long repositoryId)
throws PortalException
PortalException
protected FileEntry moveFileEntry(long userId,
long fileEntryId,
long newFolderId,
LocalRepository fromLocalRepository,
LocalRepository toLocalRepository,
ServiceContext serviceContext)
throws PortalException
PortalException
protected Folder moveFolder(long userId,
long folderId,
long parentFolderId,
LocalRepository fromLocalRepository,
LocalRepository toLocalRepository,
ServiceContext serviceContext)
throws PortalException
PortalException
|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||