com.liferay.document.library.kernel.service

Class DLAppHelperLocalServiceUtil

Object

com.liferay.document.library.kernel.service.DLAppHelperLocalServiceUtil

@ProviderType
public class DLAppHelperLocalServiceUtil
extends Object

Provides the local service utility for DLAppHelper. This utility wraps DLAppHelperLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server. 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:

DLAppHelperLocalService, DLAppHelperLocalServiceBaseImpl, DLAppHelperLocalServiceImpl

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
DLAppHelperLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static void	addFolder(long userId, Folder folder, ServiceContext serviceContext)
static void	cancelCheckOut(long userId, FileEntry fileEntry, FileVersion sourceFileVersion, FileVersion destinationFileVersion, FileVersion draftFileVersion, ServiceContext serviceContext)
static void	cancelCheckOuts(long groupId)
static void	checkAssetEntry(long userId, FileEntry fileEntry, FileVersion fileVersion)
static void	deleteFileEntry(FileEntry fileEntry)
static void	deleteFolder(Folder folder)
static void	deleteRepositoryFileEntries(long repositoryId)
static long	getCheckedOutFileEntriesCount(long groupId)
static void	getFileAsStream(long userId, FileEntry fileEntry, boolean incrementCounter)
static List<DLFileShortcut>	getFileShortcuts(long groupId, long folderId, boolean active, int status)
static int	getFileShortcutsCount(long groupId, long folderId, boolean active, int status)
static List<FileEntry>	getNoAssetFileEntries()
static String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static DLAppHelperLocalService	getService()
static void	moveDependentsToTrash(DLFolder dlFolder)
static void	moveDependentsToTrash(List<Object> dlFileEntriesAndDLFolders, long trashEntryId) Deprecated. As of Wilberforce (7.0.x), replaced by moveDependentsToTrash(DLFolder)
static FileEntry	moveFileEntryFromTrash(long userId, FileEntry fileEntry, long newFolderId, ServiceContext serviceContext)
static FileEntry	moveFileEntryToTrash(long userId, FileEntry fileEntry) Moves the file entry to the recycle bin.
static FileShortcut	moveFileShortcutFromTrash(long userId, FileShortcut fileShortcut, long newFolderId, ServiceContext serviceContext)
static FileShortcut	moveFileShortcutToTrash(long userId, FileShortcut fileShortcut) Moves the file shortcut to the recycle bin.
static Folder	moveFolderFromTrash(long userId, Folder folder, long parentFolderId, ServiceContext serviceContext)
static Folder	moveFolderToTrash(long userId, Folder folder) Moves the folder to the recycle bin.
static void	restoreDependentsFromTrash(DLFolder dlFolder)
static void	restoreDependentsFromTrash(List<Object> dlFileEntriesAndDLFolders) Deprecated. As of Wilberforce (7.0.x), replaced by restoreDependentsFromTrash(DLFolder)
static void	restoreDependentsFromTrash(List<Object> dlFileEntriesAndDLFolders, long trashEntryId) Deprecated. As of Wilberforce (7.0.x), replaced by restoreDependentsFromTrash(List)
static void	restoreFileEntryFromTrash(long userId, FileEntry fileEntry)
static void	restoreFileShortcutFromTrash(long userId, FileShortcut fileShortcut)
static void	restoreFolderFromTrash(long userId, Folder folder)
static AssetEntry	updateAsset(long userId, FileEntry fileEntry, FileVersion fileVersion, long assetClassPK)
static AssetEntry	updateAsset(long userId, FileEntry fileEntry, FileVersion fileVersion, long[] assetCategoryIds, String[] assetTagNames, long[] assetLinkEntryIds)
static AssetEntry	updateAsset(long userId, Folder folder, long[] assetCategoryIds, String[] assetTagNames, long[] assetLinkEntryIds)
static void	updateFileEntry(long userId, FileEntry fileEntry, FileVersion sourceFileVersion, FileVersion destinationFileVersion, long assetClassPK)
static void	updateFileEntry(long userId, FileEntry fileEntry, FileVersion sourceFileVersion, FileVersion destinationFileVersion, ServiceContext serviceContext)
static void	updateFolder(long userId, Folder folder, ServiceContext serviceContext)
static void	updateStatus(long userId, FileEntry fileEntry, FileVersion latestFileVersion, int oldStatus, int newStatus, ServiceContext serviceContext, Map<String,Serializable> workflowContext)

Methods inherited from class Object

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

Constructor Detail

DLAppHelperLocalServiceUtil

public DLAppHelperLocalServiceUtil()

Method Detail

addFolder

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

Throws:

PortalException

cancelCheckOut

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

Throws:

PortalException

cancelCheckOuts

public static void cancelCheckOuts(long groupId)
                            throws PortalException

Throws:

PortalException

checkAssetEntry

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

Throws:

PortalException

deleteFileEntry

public static void deleteFileEntry(FileEntry fileEntry)
                            throws PortalException

Throws:

PortalException

deleteFolder

public static void deleteFolder(Folder folder)
                         throws PortalException

Throws:

PortalException

deleteRepositoryFileEntries

public static void deleteRepositoryFileEntries(long repositoryId)
                                        throws PortalException

Throws:

PortalException

getCheckedOutFileEntriesCount

public static long getCheckedOutFileEntriesCount(long groupId)
                                          throws PortalException

Throws:

PortalException

getFileAsStream

public static void getFileAsStream(long userId,
                                   FileEntry fileEntry,
                                   boolean incrementCounter)

getFileShortcuts

public static List<DLFileShortcut> getFileShortcuts(long groupId,
                                                    long folderId,
                                                    boolean active,
                                                    int status)

getFileShortcutsCount

public static int getFileShortcutsCount(long groupId,
                                        long folderId,
                                        boolean active,
                                        int status)

getNoAssetFileEntries

public static List<FileEntry> getNoAssetFileEntries()

getOSGiServiceIdentifier

public static String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

moveDependentsToTrash

public static void moveDependentsToTrash(DLFolder dlFolder)
                                  throws PortalException

Throws:

PortalException

moveDependentsToTrash

@Deprecated
public static void moveDependentsToTrash(List<Object> dlFileEntriesAndDLFolders,
                                                     long trashEntryId)
                                              throws PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by moveDependentsToTrash(DLFolder)

Throws:

PortalException

moveFileEntryFromTrash

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

Throws:

PortalException

moveFileEntryToTrash

public static 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

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

Throws:

PortalException

moveFileShortcutToTrash

public static 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

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

Throws:

PortalException

moveFolderToTrash

public static 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

restoreDependentsFromTrash

public static void restoreDependentsFromTrash(DLFolder dlFolder)
                                       throws PortalException

Throws:

PortalException

restoreDependentsFromTrash

@Deprecated
public static void restoreDependentsFromTrash(List<Object> dlFileEntriesAndDLFolders)
                                                   throws PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by restoreDependentsFromTrash(DLFolder)

Throws:

PortalException

restoreDependentsFromTrash

@Deprecated
public static void restoreDependentsFromTrash(List<Object> dlFileEntriesAndDLFolders,
                                                          long trashEntryId)
                                                   throws PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by restoreDependentsFromTrash(List)

Throws:

PortalException

restoreFileEntryFromTrash

public static void restoreFileEntryFromTrash(long userId,
                                             FileEntry fileEntry)
                                      throws PortalException

Throws:

PortalException

restoreFileShortcutFromTrash

public static void restoreFileShortcutFromTrash(long userId,
                                                FileShortcut fileShortcut)
                                         throws PortalException

Throws:

PortalException

restoreFolderFromTrash

public static void restoreFolderFromTrash(long userId,
                                          Folder folder)
                                   throws PortalException

Throws:

PortalException

updateAsset

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

Throws:

PortalException

updateAsset

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

Throws:

PortalException

updateAsset

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

Throws:

PortalException

updateFileEntry

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

Throws:

PortalException

updateFileEntry

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

Throws:

PortalException

updateFolder

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

Throws:

PortalException

updateStatus

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

Throws:

PortalException

getService

public static DLAppHelperLocalService getService()