com.liferay.document.library.kernel.service

Interface DLAppHelperLocalService

All Superinterfaces:

BaseLocalService

All Known Implementing Classes:

DLAppHelperLocalServiceWrapper

@CTAware
 @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

{$generated.description}

Method Summary

Modifier and Type	Method and Description
void	addFolder(long userId, Folder folder, ServiceContext serviceContext)
void	cancelCheckOut(long userId, FileEntry fileEntry, FileVersion sourceFileVersion, FileVersion destinationFileVersion, FileVersion draftFileVersion, ServiceContext serviceContext)
void	cancelCheckOuts(long groupId)
void	checkAssetEntry(long userId, FileEntry fileEntry, FileVersion fileVersion)
void	deleteFileEntry(FileEntry fileEntry)
void	deleteFolder(Folder folder)
void	deleteRepositoryFileEntries(long repositoryId)
long	getCheckedOutFileEntriesCount(long groupId)
void	getFileAsStream(long userId, FileEntry fileEntry, boolean incrementCounter)
List<DLFileShortcut>	getFileShortcuts(long groupId, long folderId, boolean active, int status)
int	getFileShortcutsCount(long groupId, long folderId, boolean active, int status)
List<FileEntry>	getNoAssetFileEntries()
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
void	moveDependentsToTrash(DLFolder dlFolder)
FileEntry	moveFileEntryFromTrash(long userId, FileEntry fileEntry, long newFolderId, ServiceContext serviceContext)
FileEntry	moveFileEntryToTrash(long userId, FileEntry fileEntry) Moves the file entry to the recycle bin.
FileShortcut	moveFileShortcutFromTrash(long userId, FileShortcut fileShortcut, long newFolderId, ServiceContext serviceContext)
FileShortcut	moveFileShortcutToTrash(long userId, FileShortcut fileShortcut) Moves the file shortcut to the recycle bin.
Folder	moveFolderFromTrash(long userId, Folder folder, long parentFolderId, ServiceContext serviceContext)
Folder	moveFolderToTrash(long userId, Folder folder) Moves the folder to the recycle bin.
void	reindex(long companyId, List<Long> dlFileEntryIds)
void	restoreDependentsFromTrash(DLFolder dlFolder)
void	restoreFileEntryFromTrash(long userId, FileEntry fileEntry)
void	restoreFileEntryFromTrash(long userId, long newFolderId, FileEntry fileEntry)
void	restoreFileShortcutFromTrash(long userId, FileShortcut fileShortcut)
void	restoreFolderFromTrash(long userId, Folder folder)
AssetEntry	updateAsset(long userId, FileEntry fileEntry, FileVersion fileVersion, long assetClassPK)
AssetEntry	updateAsset(long userId, FileEntry fileEntry, FileVersion fileVersion, ServiceContext serviceContext)
AssetEntry	updateAsset(long userId, Folder folder, long[] assetCategoryIds, 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, ServiceContext serviceContext, Map<String,Serializable> workflowContext)

Method Detail

addFolder

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

Throws:

PortalException

cancelCheckOut

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

Throws:

PortalException

cancelCheckOuts

void cancelCheckOuts(long groupId)
              throws PortalException

Throws:

PortalException

checkAssetEntry

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

Throws:

PortalException

deleteFileEntry

void deleteFileEntry(FileEntry fileEntry)
              throws PortalException

Throws:

PortalException

deleteFolder

void deleteFolder(Folder folder)
           throws PortalException

Throws:

PortalException

deleteRepositoryFileEntries

void deleteRepositoryFileEntries(long repositoryId)
                          throws PortalException

Throws:

PortalException

getCheckedOutFileEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long getCheckedOutFileEntriesCount(long groupId)
                                                                                               throws PortalException

Throws:

PortalException

getFileAsStream

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

getFileShortcuts

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

getFileShortcutsCount

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

getNoAssetFileEntries

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

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

moveDependentsToTrash

void moveDependentsToTrash(DLFolder dlFolder)
                    throws PortalException

Throws:

PortalException

moveFileEntryFromTrash

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

Throws:

PortalException

moveFileEntryToTrash

FileEntry moveFileEntryToTrash(long userId,
                               FileEntry fileEntry)
                        throws PortalException

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

moveFileShortcutFromTrash

FileShortcut moveFileShortcutFromTrash(long userId,
                                       FileShortcut fileShortcut,
                                       long newFolderId,
                                       ServiceContext serviceContext)
                                throws PortalException

Throws:

PortalException

moveFileShortcutToTrash

FileShortcut moveFileShortcutToTrash(long userId,
                                     FileShortcut fileShortcut)
                              throws PortalException

Moves the file shortcut to the recycle bin.

Parameters:

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

fileShortcut - the file shortcut to be moved

Returns:

the moved file shortcut

Throws:

PortalException

moveFolderFromTrash

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

Throws:

PortalException

moveFolderToTrash

Folder moveFolderToTrash(long userId,
                         Folder folder)
                  throws PortalException

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

reindex

@Async
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
void reindex(long companyId,
                                                                                        List<Long> dlFileEntryIds)
                                                                                 throws PortalException

Throws:

PortalException

restoreDependentsFromTrash

void restoreDependentsFromTrash(DLFolder dlFolder)
                         throws PortalException

Throws:

PortalException

restoreFileEntryFromTrash

void restoreFileEntryFromTrash(long userId,
                               FileEntry fileEntry)
                        throws PortalException

Throws:

PortalException

restoreFileEntryFromTrash

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

Throws:

PortalException

restoreFileShortcutFromTrash

void restoreFileShortcutFromTrash(long userId,
                                  FileShortcut fileShortcut)
                           throws PortalException

Throws:

PortalException

restoreFolderFromTrash

void restoreFolderFromTrash(long userId,
                            Folder folder)
                     throws PortalException

Throws:

PortalException

updateAsset

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

Throws:

PortalException

updateAsset

AssetEntry updateAsset(long userId,
                       FileEntry fileEntry,
                       FileVersion fileVersion,
                       ServiceContext serviceContext)
                throws PortalException

Throws:

PortalException

updateAsset

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

Throws:

PortalException

updateFileEntry

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

Throws:

PortalException

updateFileEntry

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

Throws:

PortalException

updateFolder

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

Throws:

PortalException

updateStatus

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

Throws:

PortalException