|
Liferay 6.2.0-ce-m3 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.portlet.documentlibrary.service.DLAppLocalServiceWrapper
public class DLAppLocalServiceWrapper
This class is a wrapper for DLAppLocalService.
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. |
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. |
Folder |
getMountFolder(long repositoryId)
Returns the mount folder of the repository with the primary key. |
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. |
FileEntry |
moveFileEntryToTrash(long userId,
long fileEntryId)
Moves the file entry with the primary key to the trash portlet. |
void |
restoreFileEntryFromTrash(long userId,
long fileEntryId)
Restores the file entry with the primary key from the trash portlet. |
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 {@link java.io. |
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 |
|---|
public DLAppLocalServiceWrapper(DLAppLocalService dlAppLocalService)
| Method Detail |
|---|
public String getBeanIdentifier()
getBeanIdentifier in interface DLAppLocalServicepublic void setBeanIdentifier(String beanIdentifier)
setBeanIdentifier in interface DLAppLocalServicebeanIdentifier - the Spring bean ID for this bean
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
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.
addFileEntry in interface DLAppLocalServiceuserId - 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 - if the parent folder could not be found or if the
file entry's information was invalid
SystemException - if a system exception occurred
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
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.
addFileEntry in interface DLAppLocalServiceuserId - 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 - if the parent folder could not be found or if the
file entry's information was invalid
SystemException - if a system exception occurred
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
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.
addFileEntry in interface DLAppLocalServiceuserId - 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 - if the parent folder could not be found or if the
file entry's information was invalid
SystemException - if a system exception occurred
public DLFileRank addFileRank(long repositoryId,
long companyId,
long userId,
long fileEntryId,
ServiceContext serviceContext)
throws SystemException
addFileRank in interface DLAppLocalServicerepositoryId - 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
SystemException - if a system exception occurred
public DLFileShortcut addFileShortcut(long userId,
long repositoryId,
long folderId,
long toFileEntryId,
ServiceContext serviceContext)
throws PortalException,
SystemException
addFileShortcut in interface DLAppLocalServiceuserId - 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 - 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
public Folder addFolder(long userId,
long repositoryId,
long parentFolderId,
String name,
String description,
ServiceContext serviceContext)
throws PortalException,
SystemException
addFolder in interface DLAppLocalServiceuserId - 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 - if the parent folder could not be found or if the
new folder's information was invalid
SystemException - if a system exception occurred
public void deleteAll(long repositoryId)
throws PortalException,
SystemException
deleteAll in interface DLAppLocalServicerepositoryId - the primary key of the data's repository
PortalException - if the repository could not be found
SystemException - if a system exception occurred
public void deleteFileEntry(long fileEntryId)
throws PortalException,
SystemException
deleteFileEntry in interface DLAppLocalServicefileEntryId - the primary key of the file entry
PortalException - if the file entry could not be found
SystemException - if a system exception occurred
public void deleteFileRanksByFileEntryId(long fileEntryId)
throws SystemException
deleteFileRanksByFileEntryId in interface DLAppLocalServicefileEntryId - the primary key of the file entry
SystemException - if a system exception occurred
public void deleteFileRanksByUserId(long userId)
throws SystemException
deleteFileRanksByUserId in interface DLAppLocalServiceuserId - the primary key of the user
SystemException - if a system exception occurred
public void deleteFileShortcut(DLFileShortcut dlFileShortcut)
throws PortalException,
SystemException
deleteFileShortcut in interface DLAppLocalServicedlFileShortcut - the file shortcut
PortalException - if the file shortcut could not be found
SystemException - if a system exception occurred
public void deleteFileShortcut(long fileShortcutId)
throws PortalException,
SystemException
deleteFileShortcut in interface DLAppLocalServicefileShortcutId - the primary key of the file shortcut
PortalException - if the file shortcut could not be found
SystemException - if a system exception occurred
public void deleteFileShortcuts(long toFileEntryId)
throws PortalException,
SystemException
deleteFileShortcuts in interface DLAppLocalServicetoFileEntryId - the primary key of the associated file entry
PortalException - if the file shortcut for the file entry could not
be found
SystemException - if a system exception occurred
public void deleteFolder(long folderId)
throws PortalException,
SystemException
deleteFolder in interface DLAppLocalServicefolderId - the primary key of the folder
PortalException - if the folder could not be found
SystemException - if a system exception occurred
public FileEntry getFileEntry(long fileEntryId)
throws PortalException,
SystemException
getFileEntry in interface DLAppLocalServicefileEntryId - the primary key of the file entry
PortalException - if the file entry could not be found
SystemException - if a system exception occurred
public FileEntry getFileEntry(long groupId,
long folderId,
String title)
throws PortalException,
SystemException
getFileEntry in interface DLAppLocalServicegroupId - the primary key of the file entry's groupfolderId - the primary key of the file entry's foldertitle - the file entry's title
PortalException - if the file entry could not be found
SystemException - if a system exception occurred
public FileEntry getFileEntryByUuidAndGroupId(String uuid,
long groupId)
throws PortalException,
SystemException
getFileEntryByUuidAndGroupId in interface DLAppLocalServiceuuid - the file entry's universally unique identifiergroupId - the primary key of the file entry's group
PortalException - if the file entry could not be found
SystemException - if a system exception occurred
public List<DLFileRank> getFileRanks(long repositoryId,
long userId)
throws SystemException
getFileRanks in interface DLAppLocalServicerepositoryId - the primary key of the repositoryuserId - the primary key of the user
SystemException - if a system exception occurred
public DLFileShortcut getFileShortcut(long fileShortcutId)
throws PortalException,
SystemException
getFileShortcut in interface DLAppLocalServicefileShortcutId - the primary key of the file shortcut
PortalException - if the file shortcut could not be found
SystemException - if a system exception occurred
public FileVersion getFileVersion(long fileVersionId)
throws PortalException,
SystemException
getFileVersion in interface DLAppLocalServicefileVersionId - the primary key of the file version
PortalException - if the file version could not be found
SystemException - if a system exception occurred
public Folder getFolder(long folderId)
throws PortalException,
SystemException
getFolder in interface DLAppLocalServicefolderId - the primary key of the folder
PortalException - if the folder could not be found
SystemException - if a system exception occurred
public Folder getFolder(long repositoryId,
long parentFolderId,
String name)
throws PortalException,
SystemException
getFolder in interface DLAppLocalServicerepositoryId - the primary key of the folder's repositoryparentFolderId - the primary key of the folder's parent foldername - the folder's name
PortalException - if the folder could not be found
SystemException - if a system exception occurred
public Folder getMountFolder(long repositoryId)
throws PortalException,
SystemException
getMountFolder in interface DLAppLocalServicerepositoryId - the primary key of the repository
PortalException - if the repository or mount folder could not be
found
SystemException - if a system exception occurred
public FileEntry moveFileEntry(long userId,
long fileEntryId,
long newFolderId,
ServiceContext serviceContext)
throws PortalException,
SystemException
moveFileEntry in interface DLAppLocalServiceuserId - 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 - if the file entry or the new folder could not be
found
SystemException - if a system exception occurred
public FileEntry moveFileEntryToTrash(long userId,
long fileEntryId)
throws PortalException,
SystemException
moveFileEntryToTrash in interface DLAppLocalServiceuserId - the primary key of the userfileEntryId - the primary key of the file entry
PortalException - if the file entry could not be found
SystemException - if a system exception occurred
public void restoreFileEntryFromTrash(long userId,
long fileEntryId)
throws PortalException,
SystemException
restoreFileEntryFromTrash in interface DLAppLocalServiceuserId - the primary key of the userfileEntryId - the primary key of the file entry
PortalException - if the file entry could not be found
SystemException - if a system exception occurred
public void updateAsset(long userId,
FileEntry fileEntry,
FileVersion fileVersion,
long[] assetCategoryIds,
String[] assetTagNames,
long[] assetLinkEntryIds)
throws PortalException,
SystemException
updateAsset in interface DLAppLocalServiceuserId - 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 - if the file entry or version could not be found
SystemException - if a system exception occurred
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
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.
updateFileEntry in interface DLAppLocalServiceuserId - 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 - if the file entry could not be found
SystemException - if a system exception occurred
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
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.
updateFileEntry in interface DLAppLocalServiceuserId - 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 - EntryId the primary key of the 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. In a Liferay repository, it may
include: PortalException - if the file entry could not be found
SystemException - if a system exception occurred
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
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.
updateFileEntry in interface DLAppLocalServiceuserId - 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 - if the file entry could not be found
SystemException - if a system exception occurred
public DLFileRank updateFileRank(long repositoryId,
long companyId,
long userId,
long fileEntryId,
ServiceContext serviceContext)
throws SystemException
updateFileRank in interface DLAppLocalServicerepositoryId - 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
SystemException - if a system exception occurred
public DLFileShortcut updateFileShortcut(long userId,
long fileShortcutId,
long folderId,
long toFileEntryId,
ServiceContext serviceContext)
throws PortalException,
SystemException
updateFileShortcut in interface DLAppLocalServiceuserId - 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 - if the file shortcut, folder, or file entry could
not be found
SystemException - if a system exception occurred
public void updateFileShortcuts(long toRepositoryId,
long oldToFileEntryId,
long newToFileEntryId)
throws SystemException
updateFileShortcuts in interface DLAppLocalServicetoRepositoryId - the primary key of the repositoryoldToFileEntryId - the primary key of the old file entry pointed tonewToFileEntryId - the primary key of the new file entry to point
to
SystemException - if a system exception occurred
public Folder updateFolder(long folderId,
long parentFolderId,
String name,
String description,
ServiceContext serviceContext)
throws PortalException,
SystemException
updateFolder in interface DLAppLocalServicefolderId - 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 - 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 occurredpublic DLAppLocalService getWrappedDLAppLocalService()
getWrappedService()
public void setWrappedDLAppLocalService(DLAppLocalService dlAppLocalService)
setWrappedService(com.liferay.portlet.documentlibrary.service.DLAppLocalService)
public DLAppLocalService getWrappedService()
getWrappedService in interface ServiceWrapper<DLAppLocalService>public void setWrappedService(DLAppLocalService dlAppLocalService)
setWrappedService in interface ServiceWrapper<DLAppLocalService>
|
Liferay 6.2.0-ce-m3 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||