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:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionvoid
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) getFileShortcuts
(long groupId, long folderId, boolean active, int status) int
getFileShortcutsCount
(long groupId, long folderId, boolean active, int status) getGroupFileShortcuts
(long groupId) Returns the OSGi service identifier.void
moveDependentsToTrash
(DLFolder dlFolder) moveFileEntryFromTrash
(long userId, FileEntry fileEntry, long newFolderId, ServiceContext serviceContext) moveFileEntryToTrash
(long userId, FileEntry fileEntry) Moves the file entry to the recycle bin.moveFileShortcutFromTrash
(long userId, FileShortcut fileShortcut, long newFolderId, ServiceContext serviceContext) moveFileShortcutToTrash
(long userId, FileShortcut fileShortcut) Moves the file shortcut to the recycle bin.moveFolderFromTrash
(long userId, Folder folder, long parentFolderId, ServiceContext serviceContext) moveFolderToTrash
(long userId, Folder folder) Moves the folder to the recycle bin.void
void
restoreDependentsFromTrash
(DLFolder dlFolder) void
restoreFileEntryFromTrash
(long userId, long newFolderId, FileEntry fileEntry) void
restoreFileEntryFromTrash
(long userId, FileEntry fileEntry) void
restoreFileShortcutFromTrash
(long userId, FileShortcut fileShortcut) void
restoreFolderFromTrash
(long userId, Folder folder) updateAsset
(long userId, FileEntry fileEntry, FileVersion fileVersion, long assetClassPK) updateAsset
(long userId, FileEntry fileEntry, FileVersion fileVersion, ServiceContext serviceContext) 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 Details
-
addFolder
- Throws:
PortalException
-
cancelCheckOut
void cancelCheckOut(long userId, FileEntry fileEntry, FileVersion sourceFileVersion, FileVersion destinationFileVersion, FileVersion draftFileVersion, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
cancelCheckOuts
- Throws:
PortalException
-
checkAssetEntry
void checkAssetEntry(long userId, FileEntry fileEntry, FileVersion fileVersion) throws PortalException - Throws:
PortalException
-
deleteFileEntry
- Throws:
PortalException
-
deleteFolder
- Throws:
PortalException
-
deleteRepositoryFileEntries
- 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) -
getGroupFileShortcuts
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileShortcut> getGroupFileShortcuts(long groupId) -
getNoAssetFileEntries
-
getOSGiServiceIdentifier
String getOSGiServiceIdentifier()Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
moveDependentsToTrash
- Throws:
PortalException
-
moveFileEntryFromTrash
FileEntry moveFileEntryFromTrash(long userId, FileEntry fileEntry, long newFolderId, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
moveFileEntryToTrash
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
FileShortcut moveFileShortcutFromTrash(long userId, FileShortcut fileShortcut, long newFolderId, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
moveFileShortcutToTrash
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
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
@Async @Transactional(propagation=SUPPORTS, readOnly=true) void reindex(long companyId, List<Long> dlFileEntryIds) throws PortalException - Throws:
PortalException
-
restoreDependentsFromTrash
- Throws:
PortalException
-
restoreFileEntryFromTrash
- Throws:
PortalException
-
restoreFileEntryFromTrash
void restoreFileEntryFromTrash(long userId, long newFolderId, FileEntry fileEntry) throws PortalException - Throws:
PortalException
-
restoreFileShortcutFromTrash
- Throws:
PortalException
-
restoreFolderFromTrash
- 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
- 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
-