com.liferay.portlet.documentlibrary.service

Class DLAppHelperLocalServiceUtil

java.lang.Object

com.liferay.portlet.documentlibrary.service.DLAppHelperLocalServiceUtil

@ProviderType
public class DLAppHelperLocalServiceUtil
extends java.lang.Object

Provides the local service utility for DLAppHelper. This utility wraps com.liferay.portlet.documentlibrary.service.impl.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, com.liferay.portlet.documentlibrary.service.base.DLAppHelperLocalServiceBaseImpl, com.liferay.portlet.documentlibrary.service.impl.DLAppHelperLocalServiceImpl

Generated:

Constructor Summary

Constructors

Constructor and Description
DLAppHelperLocalServiceUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addFileEntry(long userId, FileEntry fileEntry, FileVersion fileVersion, ServiceContext serviceContext)
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	checkAssetEntry(long userId, FileEntry fileEntry, FileVersion fileVersion)
static void	deleteFileEntry(FileEntry fileEntry)
static void	deleteFolder(Folder folder)
static java.lang.String	getBeanIdentifier() Returns the Spring bean ID for this bean.
static void	getFileAsStream(long userId, FileEntry fileEntry, boolean incrementCounter)
static java.util.List<DLFileShortcut>	getFileShortcuts(long groupId, long folderId, boolean active, int status)
static java.util.List<DLFileShortcut>	getFileShortcuts(long groupId, long folderId, int status) Deprecated. As of 6.2.0, replaced by getFileShortcuts(long, long, boolean, int)
static int	getFileShortcutsCount(long groupId, long folderId, boolean active, int status)
static int	getFileShortcutsCount(long groupId, long folderId, int status) Deprecated. As of 6.2.0, replaced by getFileShortcutsCount(long, long, boolean, int)
static java.util.List<FileEntry>	getNoAssetFileEntries()
static DLAppHelperLocalService	getService()
static void	moveDependentsToTrash(java.util.List<java.lang.Object> dlFileEntriesAndDLFolders, long trashEntryId)
static void	moveFileEntry(FileEntry fileEntry)
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 DLFileShortcut	moveFileShortcutFromTrash(long userId, DLFileShortcut dlFileShortcut, long newFolderId, ServiceContext serviceContext)
static DLFileShortcut	moveFileShortcutToTrash(long userId, DLFileShortcut dlFileShortcut) Moves the file shortcut to the recycle bin.
static void	moveFolder(Folder folder)
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	registerDLSyncEventCallback(java.lang.String event, FileEntry fileEntry)
static void	registerDLSyncEventCallback(java.lang.String event, Folder folder)
static void	restoreDependentsFromTrash(java.util.List<java.lang.Object> dlFileEntriesAndDLFolders, long trashEntryId)
static void	restoreFileEntryFromTrash(long userId, FileEntry fileEntry)
static void	restoreFileShortcutFromTrash(long userId, DLFileShortcut dlFileShortcut)
static void	restoreFolderFromTrash(long userId, Folder folder)
static void	setBeanIdentifier(java.lang.String beanIdentifier) Sets the Spring bean ID for this bean.
void	setService(DLAppHelperLocalService service) Deprecated. As of 6.2.0
static AssetEntry	updateAsset(long userId, FileEntry fileEntry, FileVersion fileVersion, long assetClassPk)
static AssetEntry	updateAsset(long userId, FileEntry fileEntry, FileVersion fileVersion, long[] assetCategoryIds, java.lang.String[] assetTagNames, long[] assetLinkEntryIds)
static AssetEntry	updateAsset(long userId, Folder folder, long[] assetCategoryIds, java.lang.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, java.util.Map<java.lang.String,java.io.Serializable> workflowContext, ServiceContext serviceContext)

Methods inherited from class java.lang.Object

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

Constructor Detail

DLAppHelperLocalServiceUtil

public DLAppHelperLocalServiceUtil()

Method Detail

getBeanIdentifier

public static java.lang.String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(java.lang.String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addFileEntry

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

Throws:

PortalException

SystemException

addFolder

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

Throws:

PortalException

SystemException

cancelCheckOut

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

Throws:

PortalException

SystemException

checkAssetEntry

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

Throws:

PortalException

SystemException

deleteFileEntry

public static void deleteFileEntry(FileEntry fileEntry)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

deleteFolder

public static void deleteFolder(Folder folder)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

getFileAsStream

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

Throws:

SystemException

getFileShortcuts

public static java.util.List<DLFileShortcut> getFileShortcuts(long groupId,
                                              long folderId,
                                              boolean active,
                                              int status)
                                                       throws SystemException

Throws:

SystemException

getFileShortcuts

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

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

Throws:

SystemException

getFileShortcutsCount

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

public static java.util.List<FileEntry> getNoAssetFileEntries()

moveDependentsToTrash

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

Throws:

PortalException

SystemException

moveFileEntry

public static void moveFileEntry(FileEntry fileEntry)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

moveFileEntryFromTrash

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

Throws:

PortalException

SystemException

moveFileEntryToTrash

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

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

Throws:

PortalException

SystemException

moveFileShortcutToTrash

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

public static void moveFolder(Folder folder)
                       throws SystemException

Throws:

SystemException

moveFolderFromTrash

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

Throws:

PortalException

SystemException

moveFolderToTrash

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

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

Throws:

PortalException

SystemException

registerDLSyncEventCallback

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

Throws:

SystemException

restoreDependentsFromTrash

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

Throws:

PortalException

SystemException

restoreFileEntryFromTrash

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

Throws:

PortalException

SystemException

restoreFileShortcutFromTrash

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

Throws:

PortalException

SystemException

restoreFolderFromTrash

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

Throws:

PortalException

SystemException

updateAsset

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

Throws:

PortalException

SystemException

updateAsset

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

Throws:

PortalException

SystemException

updateAsset

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

Throws:

PortalException

SystemException

updateFileEntry

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

Throws:

PortalException

SystemException

updateFileEntry

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

Throws:

PortalException

SystemException

updateFolder

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

Throws:

PortalException

SystemException

updateStatus

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

getService

public static DLAppHelperLocalService getService()

setService

public void setService(DLAppHelperLocalService service)

Deprecated. As of 6.2.0