public interface TaskManager
Modifier and Type | Method and Description |
---|---|
void |
completeTask(java.lang.String taskId,
java.lang.String actionId)
Completes the task with the given id and action.
|
Task |
createTask(java.lang.String parentTaskId,
Task task)
Creates a subtask under the specified parentTaskid
|
Task |
createTask(Task task)
Creates a task.
|
void |
deleteTask(java.lang.String taskId)
Deletes the task with the given task ID.
|
Task |
getTask(java.lang.String taskId)
Retrieves a fully populated task instance for the given task id.
|
Task |
getTask(java.lang.String taskId,
boolean retrieveSubTasks)
Retrieves the task identified by taskId and opotionally retrieves the task's subtasks.
|
TaskManagerFactory |
getTaskManagerFactory()
Returns a task manager factory to instantiate various objects of the taskmanager interface like Task and TaskAction.
|
java.util.Iterator<Task> |
getTasks(Filter filter)
Same as calling
getTasks(Filter, int, int) with startIndex of 0, and length of -1
Used as a convenience for calls that do not need to limit the number of tasks being returned |
java.util.Iterator<Task> |
getTasks(Filter filter,
int startIndex,
int length)
returns all tasks for the specified task type, or all tasks if no tasktype specified.
|
Task |
saveTask(Task task)
Saves the given task instance.
|
void |
terminateTask(java.lang.String taskId)
Terminates the task
|
Task createTask(Task task) throws TaskManagerException
task
- Task to createTaskManagerException
- An error occurred creating the task.Task createTask(java.lang.String parentTaskId, Task task) throws TaskNotFoundException, TaskManagerException
parentTaskId
- the id of the parent tasktask
- the task to createTaskNotFoundException
- if the parent task specified is not foundTaskManagerException
- an error occurred creating the task.java.util.Iterator<Task> getTasks(Filter filter, int startIndex, int length) throws TaskManagerException
filter
- Only tasks matching the conditions in this filter are returned in the resulting iterator.startIndex
- The index of the first task returned. This value must be > 0length
- The maximum number of tasks returned. This value must be non-zero. A negative value indicates all results are to be returnedTaskManagerException
- An error occurred retrieving the tasks.java.util.Iterator<Task> getTasks(Filter filter) throws TaskManagerException
getTasks(Filter, int, int)
with startIndex of 0, and length of -1
Used as a convenience for calls that do not need to limit the number of tasks being returnedfilter
- Only tasks matching the conditions in this filter are returned in the resulting iterator.TaskManagerException
- An error occurred retrieving the tasksTask getTask(java.lang.String taskId) throws TaskManagerException
taskId
- String containing a task id.TaskManagerException
- An error occurred retrieving the task instance.Task getTask(java.lang.String taskId, boolean retrieveSubTasks) throws TaskManagerException
taskId
- String containing a task id.retrieveSubTasks
- true to retrieve this task's subtasks, false otherwise.TaskManagerException
- an error occurred retrieving the task instance.Task saveTask(Task task) throws TaskNotFoundException, TaskManagerException
completeTask(String, String)
task
- Task instance to save.TaskNotFoundException
- The task being saved could not be foundTaskManagerException
- An error occurred saving the task instance.void deleteTask(java.lang.String taskId) throws TaskNotFoundException, TaskManagerException
taskId
- String containing the ID of the task to delete.TaskNotFoundException
- The task being saved could not be foundTaskManagerException
- An error occurred deleting the task instance.void completeTask(java.lang.String taskId, java.lang.String actionId) throws TaskNotFoundException, TaskManagerException
taskId
- String containing the ID of the task to complete.actionId
- the Id of the action to complete the task with, or null.TaskNotFoundException
- The task being completed could not be foundTaskManagerException
- An error occurred completing the task instance.void terminateTask(java.lang.String taskId) throws TaskNotFoundException, TaskManagerException
taskId
- String containing the ID of the task to complete.TaskNotFoundException
- The task being completed could not be foundTaskManagerException
- An error occurred completing the task instance.TaskManagerFactory getTaskManagerFactory()
TaskManagerFactory
Copyright © 2010 - 2020 Adobe. All Rights Reserved