Class DLAppHelperLocalServiceUtil
Object
com.liferay.document.library.kernel.service.DLAppHelperLocalServiceUtil
Provides the local service utility for DLAppHelper. This utility wraps
com.liferay.portlet.documentlibrary.service.impl.DLAppHelperLocalServiceImpl
and
is an 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:
- {$generated.description}
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic 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<DLFileShortcut>
getGroupFileShortcuts
(long groupId) static String
Returns the OSGi service identifier.static DLAppHelperLocalService
static void
moveDependentsToTrash
(DLFolder 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
static void
restoreDependentsFromTrash
(DLFolder dlFolder) static void
restoreFileEntryFromTrash
(long userId, long newFolderId, FileEntry fileEntry) static void
restoreFileEntryFromTrash
(long userId, FileEntry fileEntry) static void
restoreFileShortcutFromTrash
(long userId, FileShortcut fileShortcut) static void
restoreFolderFromTrash
(long userId, Folder folder) static void
setService
(DLAppHelperLocalService service) static AssetEntry
updateAsset
(long userId, FileEntry fileEntry, FileVersion fileVersion, long assetClassPK) static AssetEntry
updateAsset
(long userId, FileEntry fileEntry, FileVersion fileVersion, ServiceContext serviceContext) 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)
-
Constructor Details
-
DLAppHelperLocalServiceUtil
public DLAppHelperLocalServiceUtil()
-
-
Method Details
-
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
- Throws:
PortalException
-
checkAssetEntry
public static void checkAssetEntry(long userId, FileEntry fileEntry, FileVersion fileVersion) throws PortalException - Throws:
PortalException
-
deleteFileEntry
- Throws:
PortalException
-
deleteFolder
- Throws:
PortalException
-
deleteRepositoryFileEntries
- Throws:
PortalException
-
getCheckedOutFileEntriesCount
- Throws:
PortalException
-
getFileAsStream
-
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) -
getGroupFileShortcuts
-
getNoAssetFileEntries
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
moveDependentsToTrash
- 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 entryfileEntry
- 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 shortcutfileShortcut
- 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
Moves the folder to the recycle bin.- Parameters:
userId
- the primary key of the user moving the folderfolder
- the folder to be moved- Returns:
- the moved folder
- Throws:
PortalException
-
reindex
- Throws:
PortalException
-
restoreDependentsFromTrash
- Throws:
PortalException
-
restoreFileEntryFromTrash
public static void restoreFileEntryFromTrash(long userId, FileEntry fileEntry) throws PortalException - Throws:
PortalException
-
restoreFileEntryFromTrash
public static void restoreFileEntryFromTrash(long userId, long newFolderId, FileEntry fileEntry) throws PortalException - Throws:
PortalException
-
restoreFileShortcutFromTrash
public static void restoreFileShortcutFromTrash(long userId, FileShortcut fileShortcut) throws PortalException - Throws:
PortalException
-
restoreFolderFromTrash
- 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, ServiceContext serviceContext) 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
-
setService
-