com.liferay.portlet.documentlibrary.service

Interface DLAppHelperLocalService

All Superinterfaces:

BaseLocalService

All Known Implementing Classes:

DLAppHelperLocalServiceWrapper

@ProviderType
@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface DLAppHelperLocalService
extends BaseLocalService

Provides the local service interface for DLAppHelper. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

Author:

Brian Wing Shun Chan

See Also:

DLAppHelperLocalServiceUtil, com.liferay.portlet.documentlibrary.service.base.DLAppHelperLocalServiceBaseImpl, com.liferay.portlet.documentlibrary.service.impl.DLAppHelperLocalServiceImpl

Generated:

Method Summary

Methods

Modifier and Type	Method and Description
void	addFileEntry(long userId, FileEntry fileEntry, FileVersion fileVersion, ServiceContext serviceContext)
void	addFolder(long userId, Folder folder, ServiceContext serviceContext)
void	cancelCheckOut(long userId, FileEntry fileEntry, FileVersion sourceFileVersion, FileVersion destinationFileVersion, FileVersion draftFileVersion, ServiceContext serviceContext)
void	checkAssetEntry(long userId, FileEntry fileEntry, FileVersion fileVersion)
void	deleteFileEntry(FileEntry fileEntry)
void	deleteFolder(Folder folder)
java.lang.String	getBeanIdentifier() Returns the Spring bean ID for this bean.
void	getFileAsStream(long userId, FileEntry fileEntry, boolean incrementCounter)
java.util.List<DLFileShortcut>	getFileShortcuts(long groupId, long folderId, boolean active, int status)
java.util.List<DLFileShortcut>	getFileShortcuts(long groupId, long folderId, int status) Deprecated. As of 6.2.0, replaced by getFileShortcuts(long, long, boolean, int)
int	getFileShortcutsCount(long groupId, long folderId, boolean active, int status)
int	getFileShortcutsCount(long groupId, long folderId, int status) Deprecated. As of 6.2.0, replaced by getFileShortcutsCount(long, long, boolean, int)
java.util.List<FileEntry>	getNoAssetFileEntries()
void	moveDependentsToTrash(java.util.List<java.lang.Object> dlFileEntriesAndDLFolders, long trashEntryId)
void	moveFileEntry(FileEntry fileEntry)
FileEntry	moveFileEntryFromTrash(long userId, FileEntry fileEntry, long newFolderId, ServiceContext serviceContext)
FileEntry	moveFileEntryToTrash(long userId, FileEntry fileEntry) Moves the file entry to the recycle bin.
DLFileShortcut	moveFileShortcutFromTrash(long userId, DLFileShortcut dlFileShortcut, long newFolderId, ServiceContext serviceContext)
DLFileShortcut	moveFileShortcutToTrash(long userId, DLFileShortcut dlFileShortcut) Moves the file shortcut to the recycle bin.
void	moveFolder(Folder folder)
Folder	moveFolderFromTrash(long userId, Folder folder, long parentFolderId, ServiceContext serviceContext)
Folder	moveFolderToTrash(long userId, Folder folder) Moves the folder to the recycle bin.
void	registerDLSyncEventCallback(java.lang.String event, FileEntry fileEntry)
void	registerDLSyncEventCallback(java.lang.String event, Folder folder)
void	restoreDependentsFromTrash(java.util.List<java.lang.Object> dlFileEntriesAndDLFolders, long trashEntryId)
void	restoreFileEntryFromTrash(long userId, FileEntry fileEntry)
void	restoreFileShortcutFromTrash(long userId, DLFileShortcut dlFileShortcut)
void	restoreFolderFromTrash(long userId, Folder folder)
void	setBeanIdentifier(java.lang.String beanIdentifier) Sets the Spring bean ID for this bean.
AssetEntry	updateAsset(long userId, FileEntry fileEntry, FileVersion fileVersion, long assetClassPk)
AssetEntry	updateAsset(long userId, FileEntry fileEntry, FileVersion fileVersion, long[] assetCategoryIds, java.lang.String[] assetTagNames, long[] assetLinkEntryIds)
AssetEntry	updateAsset(long userId, Folder folder, long[] assetCategoryIds, java.lang.String[] assetTagNames, long[] assetLinkEntryIds)
void	updateFileEntry(long userId, FileEntry fileEntry, FileVersion sourceFileVersion, FileVersion destinationFileVersion, long assetClassPk)
void	updateFileEntry(long userId, FileEntry fileEntry, FileVersion sourceFileVersion, FileVersion destinationFileVersion, ServiceContext serviceContext)
void	updateFolder(long userId, Folder folder, ServiceContext serviceContext)
void	updateStatus(long userId, FileEntry fileEntry, FileVersion latestFileVersion, int oldStatus, int newStatus, java.util.Map<java.lang.String,java.io.Serializable> workflowContext, ServiceContext serviceContext)

Method Detail

getBeanIdentifier

java.lang.String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(java.lang.String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addFileEntry

void addFileEntry(long userId,
                FileEntry fileEntry,
                FileVersion fileVersion,
                ServiceContext serviceContext)
                  throws PortalException,
                         SystemException

Throws:

PortalException

SystemException

addFolder

void addFolder(long userId,
             Folder folder,
             ServiceContext serviceContext)
               throws PortalException,
                      SystemException

Throws:

PortalException

SystemException

cancelCheckOut

void cancelCheckOut(long userId,
                  FileEntry fileEntry,
                  FileVersion sourceFileVersion,
                  FileVersion destinationFileVersion,
                  FileVersion draftFileVersion,
                  ServiceContext serviceContext)
                    throws PortalException,
                           SystemException

Throws:

PortalException

SystemException

checkAssetEntry

void checkAssetEntry(long userId,
                   FileEntry fileEntry,
                   FileVersion fileVersion)
                     throws PortalException,
                            SystemException

Throws:

PortalException

SystemException

deleteFileEntry

void deleteFileEntry(FileEntry fileEntry)
                     throws PortalException,
                            SystemException

Throws:

PortalException

SystemException

deleteFolder

void deleteFolder(Folder folder)
                  throws PortalException,
                         SystemException

Throws:

PortalException

SystemException

getFileAsStream

@Transactional(propagation=SUPPORTS,
               readOnly=true)
void getFileAsStream(long userId,
                                                            FileEntry fileEntry,
                                                            boolean incrementCounter)
                     throws SystemException

Throws:

SystemException

getFileShortcuts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DLFileShortcut> getFileShortcuts(long groupId,
                                                                                       long folderId,
                                                                                       boolean active,
                                                                                       int status)
                                                throws SystemException

Throws:

SystemException

getFileShortcuts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<DLFileShortcut> getFileShortcuts(long groupId,
                                                                                       long folderId,
                                                                                       int status)
                                                throws SystemException

Deprecated. As of 6.2.0, replaced by getFileShortcuts(long, long, boolean, int)

Throws:

SystemException

getFileShortcutsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFileShortcutsCount(long groupId,
                                                                 long folderId,
                                                                 boolean active,
                                                                 int status)
                          throws SystemException

Throws:

SystemException

getFileShortcutsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFileShortcutsCount(long groupId,
                                                                 long folderId,
                                                                 int status)
                          throws SystemException

Deprecated. As of 6.2.0, replaced by getFileShortcutsCount(long, long, boolean, int)

Throws:

SystemException

getNoAssetFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<FileEntry> getNoAssetFileEntries()

moveDependentsToTrash

void moveDependentsToTrash(java.util.List<java.lang.Object> dlFileEntriesAndDLFolders,
                         long trashEntryId)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

moveFileEntry

void moveFileEntry(FileEntry fileEntry)
                   throws PortalException,
                          SystemException

Throws:

PortalException

SystemException

moveFileEntryFromTrash

FileEntry moveFileEntryFromTrash(long userId,
                               FileEntry fileEntry,
                               long newFolderId,
                               ServiceContext serviceContext)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

moveFileEntryToTrash

FileEntry moveFileEntryToTrash(long userId,
                             FileEntry fileEntry)
                               throws PortalException,
                                      SystemException

Moves the file entry to the recycle bin.

Parameters:

userId - the primary key of the user moving the file entry

fileEntry - the file entry to be moved

Returns:

the moved file entry

Throws:

PortalException - if a user with the primary key could not be found

SystemException - if a system exception occurred

moveFileShortcutFromTrash

DLFileShortcut moveFileShortcutFromTrash(long userId,
                                       DLFileShortcut dlFileShortcut,
                                       long newFolderId,
                                       ServiceContext serviceContext)
                                         throws PortalException,
                                                SystemException

Throws:

PortalException

SystemException

moveFileShortcutToTrash

DLFileShortcut moveFileShortcutToTrash(long userId,
                                     DLFileShortcut dlFileShortcut)
                                       throws PortalException,
                                              SystemException

Moves the file shortcut to the recycle bin.

Parameters:

userId - the primary key of the user moving the file shortcut

dlFileShortcut - the file shortcut to be moved

Returns:

the moved file shortcut

Throws:

PortalException - if a user with the primary key could not be found

SystemException - if a system exception occurred

moveFolder

void moveFolder(Folder folder)
                throws SystemException

Throws:

SystemException

moveFolderFromTrash

Folder moveFolderFromTrash(long userId,
                         Folder folder,
                         long parentFolderId,
                         ServiceContext serviceContext)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

moveFolderToTrash

Folder moveFolderToTrash(long userId,
                       Folder folder)
                         throws PortalException,
                                SystemException

Moves the folder to the recycle bin.

Parameters:

userId - the primary key of the user moving the folder

folder - the folder to be moved

Returns:

the moved folder

Throws:

PortalException - if a user with the primary key could not be found

SystemException - if a system exception occurred

registerDLSyncEventCallback

void registerDLSyncEventCallback(java.lang.String event,
                               FileEntry fileEntry)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

registerDLSyncEventCallback

void registerDLSyncEventCallback(java.lang.String event,
                               Folder folder)
                                 throws SystemException

Throws:

SystemException

restoreDependentsFromTrash

void restoreDependentsFromTrash(java.util.List<java.lang.Object> dlFileEntriesAndDLFolders,
                              long trashEntryId)
                                throws PortalException,
                                       SystemException

Throws:

PortalException

SystemException

restoreFileEntryFromTrash

void restoreFileEntryFromTrash(long userId,
                             FileEntry fileEntry)
                               throws PortalException,
                                      SystemException

Throws:

PortalException

SystemException

restoreFileShortcutFromTrash

void restoreFileShortcutFromTrash(long userId,
                                DLFileShortcut dlFileShortcut)
                                  throws PortalException,
                                         SystemException

Throws:

PortalException

SystemException

restoreFolderFromTrash

void restoreFolderFromTrash(long userId,
                          Folder folder)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

updateAsset

AssetEntry updateAsset(long userId,
                     FileEntry fileEntry,
                     FileVersion fileVersion,
                     long assetClassPk)
                       throws PortalException,
                              SystemException

Throws:

PortalException

SystemException

updateAsset

AssetEntry updateAsset(long userId,
                     FileEntry fileEntry,
                     FileVersion fileVersion,
                     long[] assetCategoryIds,
                     java.lang.String[] assetTagNames,
                     long[] assetLinkEntryIds)
                       throws PortalException,
                              SystemException

Throws:

PortalException

SystemException

updateAsset

AssetEntry updateAsset(long userId,
                     Folder folder,
                     long[] assetCategoryIds,
                     java.lang.String[] assetTagNames,
                     long[] assetLinkEntryIds)
                       throws PortalException,
                              SystemException

Throws:

PortalException

SystemException

updateFileEntry

void updateFileEntry(long userId,
                   FileEntry fileEntry,
                   FileVersion sourceFileVersion,
                   FileVersion destinationFileVersion,
                   long assetClassPk)
                     throws PortalException,
                            SystemException

Throws:

PortalException

SystemException

updateFileEntry

void updateFileEntry(long userId,
                   FileEntry fileEntry,
                   FileVersion sourceFileVersion,
                   FileVersion destinationFileVersion,
                   ServiceContext serviceContext)
                     throws PortalException,
                            SystemException

Throws:

PortalException

SystemException

updateFolder

void updateFolder(long userId,
                Folder folder,
                ServiceContext serviceContext)
                  throws PortalException,
                         SystemException

Throws:

PortalException

SystemException

updateStatus

void updateStatus(long userId,
                FileEntry fileEntry,
                FileVersion latestFileVersion,
                int oldStatus,
                int newStatus,
                java.util.Map<java.lang.String,java.io.Serializable> workflowContext,
                ServiceContext serviceContext)
                  throws PortalException,
                         SystemException

Throws:

PortalException

SystemException