Interface BackgroundTaskManager
@ProviderType
public interface BackgroundTaskManager
- Author:
- Michael C. Han
-
Method Summary
Modifier and TypeMethodDescriptionaddBackgroundTask
(long userId, long groupId, String name, String[] servletContextNames, Class<?> taskExecutorClass, Map<String, Serializable> taskContextMap, ServiceContext serviceContext) addBackgroundTask
(long userId, long groupId, String name, String taskExecutorClassName, Map<String, Serializable> taskContextMap, ServiceContext serviceContext) void
addBackgroundTaskAttachment
(long userId, long backgroundTaskId, String fileName, File file) void
addBackgroundTaskAttachment
(long userId, long backgroundTaskId, String fileName, InputStream inputStream) amendBackgroundTask
(long backgroundTaskId, Map<String, Serializable> taskContextMap, int status, ServiceContext serviceContext) amendBackgroundTask
(long backgroundTaskId, Map<String, Serializable> taskContextMap, int status, String statusMessage, ServiceContext serviceContext) void
cleanUpBackgroundTask
(BackgroundTask backgroundTask, int status) void
deleteBackgroundTask
(long backgroundTaskId) void
deleteCompanyBackgroundTasks
(long companyId) void
deleteGroupBackgroundTasks
(long groupId) void
deleteGroupBackgroundTasks
(long groupId, String name, String taskExecutorClassName) fetchBackgroundTask
(long backgroundTaskId) fetchFirstBackgroundTask
(long groupId, String taskExecutorClassName, boolean completed, OrderByComparator<BackgroundTask> orderByComparator) fetchFirstBackgroundTask
(String taskExecutorClassName, int status) fetchFirstBackgroundTask
(String taskExecutorClassName, int status, OrderByComparator<BackgroundTask> orderByComparator) getBackgroundTask
(long backgroundTaskId) getBackgroundTasks
(long[] groupIds, String taskExecutorClassName, boolean completed, int start, int end, OrderByComparator<BackgroundTask> orderByComparator) getBackgroundTasks
(long[] groupIds, String taskExecutorClassName, int start, int end, OrderByComparator<BackgroundTask> orderByComparator) getBackgroundTasks
(long[] groupIds, String name, String[] taskExecutorClassNames, int start, int end, OrderByComparator<BackgroundTask> orderByComparator) getBackgroundTasks
(long[] groupIds, String name, String taskExecutorClassName, int start, int end, OrderByComparator<BackgroundTask> orderByComparator) getBackgroundTasks
(long groupId, int status) getBackgroundTasks
(long groupId, String taskExecutorClassName) getBackgroundTasks
(long groupId, String[] taskExecutorClassNames) getBackgroundTasks
(long groupId, String[] taskExecutorClassNames, int status) getBackgroundTasks
(long groupId, String[] taskExecutorClassNames, int start, int end, OrderByComparator<BackgroundTask> orderByComparator) getBackgroundTasks
(long groupId, String taskExecutorClassName, boolean completed, int start, int end, OrderByComparator<BackgroundTask> orderByComparator) getBackgroundTasks
(long groupId, String taskExecutorClassName, int status) getBackgroundTasks
(long groupId, String taskExecutorClassName, int start, int end, OrderByComparator<BackgroundTask> orderByComparator) getBackgroundTasks
(long groupId, String name, String taskExecutorClassName, int start, int end, OrderByComparator<BackgroundTask> orderByComparator) getBackgroundTasks
(String[] taskExecutorClassNames, int status) getBackgroundTasks
(String[] taskExecutorClassNames, int status, int start, int end, OrderByComparator<BackgroundTask> orderByComparator) getBackgroundTasks
(String taskExecutorClassName, int status) getBackgroundTasks
(String taskExecutorClassName, int status, int start, int end, OrderByComparator<BackgroundTask> orderByComparator) getBackgroundTasksByDuration
(long[] groupIds, String[] taskExecutorClassName, boolean completed, int start, int end, boolean orderByType) getBackgroundTasksByDuration
(long[] groupIds, String[] taskExecutorClassName, int start, int end, boolean orderByType) int
getBackgroundTasksCount
(long[] groupIds, String taskExecutorClassName) int
getBackgroundTasksCount
(long[] groupIds, String taskExecutorClassName, boolean completed) int
getBackgroundTasksCount
(long[] groupIds, String name, String taskExecutorClassName) int
getBackgroundTasksCount
(long[] groupIds, String name, String[] taskExecutorClassNames) int
getBackgroundTasksCount
(long[] groupIds, String name, String taskExecutorClassName, boolean completed) int
getBackgroundTasksCount
(long groupId, String taskExecutorClassName) int
getBackgroundTasksCount
(long groupId, String[] taskExecutorClassNames) int
getBackgroundTasksCount
(long groupId, String[] taskExecutorClassNames, boolean completed) int
getBackgroundTasksCount
(long groupId, String taskExecutorClassName, boolean completed) int
getBackgroundTasksCount
(long groupId, String name, String taskExecutorClassName) int
getBackgroundTasksCount
(long groupId, String name, String taskExecutorClassName, boolean completed) getBackgroundTaskStatusJSON
(long backgroundTaskId) void
resumeBackgroundTask
(long backgroundTaskId) void
triggerBackgroundTask
(long backgroundTaskId)
-
Method Details
-
addBackgroundTask
BackgroundTask addBackgroundTask(long userId, long groupId, String name, String taskExecutorClassName, Map<String, Serializable> taskContextMap, ServiceContext serviceContext) throws PortalException- Throws:
PortalException
-
addBackgroundTask
BackgroundTask addBackgroundTask(long userId, long groupId, String name, String[] servletContextNames, Class<?> taskExecutorClass, Map<String, Serializable> taskContextMap, ServiceContext serviceContext) throws PortalException- Throws:
PortalException
-
addBackgroundTaskAttachment
void addBackgroundTaskAttachment(long userId, long backgroundTaskId, String fileName, File file) throws PortalException - Throws:
PortalException
-
addBackgroundTaskAttachment
void addBackgroundTaskAttachment(long userId, long backgroundTaskId, String fileName, InputStream inputStream) throws PortalException - Throws:
PortalException
-
amendBackgroundTask
BackgroundTask amendBackgroundTask(long backgroundTaskId, Map<String, Serializable> taskContextMap, int status, ServiceContext serviceContext) -
amendBackgroundTask
BackgroundTask amendBackgroundTask(long backgroundTaskId, Map<String, Serializable> taskContextMap, int status, String statusMessage, ServiceContext serviceContext) -
cleanUpBackgroundTask
-
cleanUpBackgroundTasks
void cleanUpBackgroundTasks() -
deleteBackgroundTask
- Throws:
PortalException
-
deleteCompanyBackgroundTasks
- Throws:
PortalException
-
deleteGroupBackgroundTasks
- Throws:
PortalException
-
deleteGroupBackgroundTasks
void deleteGroupBackgroundTasks(long groupId, String name, String taskExecutorClassName) throws PortalException - Throws:
PortalException
-
fetchBackgroundTask
-
fetchFirstBackgroundTask
BackgroundTask fetchFirstBackgroundTask(long groupId, String taskExecutorClassName, boolean completed, OrderByComparator<BackgroundTask> orderByComparator) -
fetchFirstBackgroundTask
-
fetchFirstBackgroundTask
BackgroundTask fetchFirstBackgroundTask(String taskExecutorClassName, int status, OrderByComparator<BackgroundTask> orderByComparator) -
getBackgroundTask
- Throws:
PortalException
-
getBackgroundTasks
-
getBackgroundTasks
-
getBackgroundTasks
List<BackgroundTask> getBackgroundTasks(long groupId, String taskExecutorClassName, boolean completed, int start, int end, OrderByComparator<BackgroundTask> orderByComparator) -
getBackgroundTasks
-
getBackgroundTasks
List<BackgroundTask> getBackgroundTasks(long groupId, String taskExecutorClassName, int start, int end, OrderByComparator<BackgroundTask> orderByComparator) -
getBackgroundTasks
List<BackgroundTask> getBackgroundTasks(long groupId, String name, String taskExecutorClassName, int start, int end, OrderByComparator<BackgroundTask> orderByComparator) -
getBackgroundTasks
-
getBackgroundTasks
-
getBackgroundTasks
List<BackgroundTask> getBackgroundTasks(long groupId, String[] taskExecutorClassNames, int start, int end, OrderByComparator<BackgroundTask> orderByComparator) -
getBackgroundTasks
List<BackgroundTask> getBackgroundTasks(long[] groupIds, String taskExecutorClassName, boolean completed, int start, int end, OrderByComparator<BackgroundTask> orderByComparator) -
getBackgroundTasks
List<BackgroundTask> getBackgroundTasks(long[] groupIds, String taskExecutorClassName, int start, int end, OrderByComparator<BackgroundTask> orderByComparator) -
getBackgroundTasks
List<BackgroundTask> getBackgroundTasks(long[] groupIds, String name, String taskExecutorClassName, int start, int end, OrderByComparator<BackgroundTask> orderByComparator) -
getBackgroundTasks
List<BackgroundTask> getBackgroundTasks(long[] groupIds, String name, String[] taskExecutorClassNames, int start, int end, OrderByComparator<BackgroundTask> orderByComparator) -
getBackgroundTasks
-
getBackgroundTasks
List<BackgroundTask> getBackgroundTasks(String taskExecutorClassName, int status, int start, int end, OrderByComparator<BackgroundTask> orderByComparator) -
getBackgroundTasks
-
getBackgroundTasks
List<BackgroundTask> getBackgroundTasks(String[] taskExecutorClassNames, int status, int start, int end, OrderByComparator<BackgroundTask> orderByComparator) -
getBackgroundTasksByDuration
List<BackgroundTask> getBackgroundTasksByDuration(long[] groupIds, String[] taskExecutorClassName, boolean completed, int start, int end, boolean orderByType) -
getBackgroundTasksByDuration
List<BackgroundTask> getBackgroundTasksByDuration(long[] groupIds, String[] taskExecutorClassName, int start, int end, boolean orderByType) -
getBackgroundTasksCount
-
getBackgroundTasksCount
-
getBackgroundTasksCount
-
getBackgroundTasksCount
-
getBackgroundTasksCount
-
getBackgroundTasksCount
-
getBackgroundTasksCount
-
getBackgroundTasksCount
-
getBackgroundTasksCount
-
getBackgroundTasksCount
-
getBackgroundTasksCount
-
getBackgroundTaskStatusJSON
-
resumeBackgroundTask
void resumeBackgroundTask(long backgroundTaskId) -
triggerBackgroundTask
void triggerBackgroundTask(long backgroundTaskId)
-