Package org.silverpeas.core.workflow.api
Interface TaskManager
-
- All Known Implementing Classes:
AbstractTaskManager
,TaskManagerImpl
public interface TaskManager
The workflow engine services relate to task management.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
assignTask(Task task, User delegator)
Adds a new task in the user's todos.Task
createTask(Actor actor, ProcessInstance processInstance)
Builds a new task (assigned or assignable).Task[]
createTasks(Actor[] actors, ProcessInstance processInstance)
Builds new tasks (assigned or assignable).Task
getCreationTask(User user, String roleName, ProcessModel processModel)
Returns the creation task of a processModel or null if the user is not allowed to create a new instance.String
getProcessInstanceIdFromExternalTodoId(String externalTodoId)
Get the process instance Id referred by the task to do with the given identifier.String
getRoleNameFromExternalTodoId(String externalTodoId)
Get the role name of task referred by the task to do with the given identifierTask[]
getTasks(User user, String roleName, ProcessInstance processInstance)
Returns the tasks assigned to a user on a processInstance.void
notifyActor(Task task, User sender, Actor user, String text, boolean linkDisabled)
Notify user that an action has been donevoid
unAssignTask(Task task)
Removes a task from the user's todos.
-
-
-
Method Detail
-
assignTask
void assignTask(Task task, User delegator) throws WorkflowException
Adds a new task in the user's todos.- Throws:
WorkflowException
-
unAssignTask
void unAssignTask(Task task) throws WorkflowException
Removes a task from the user's todos.- Throws:
WorkflowException
-
createTask
Task createTask(Actor actor, ProcessInstance processInstance) throws WorkflowException
Builds a new task (assigned or assignable).- Throws:
WorkflowException
-
createTasks
Task[] createTasks(Actor[] actors, ProcessInstance processInstance) throws WorkflowException
Builds new tasks (assigned or assignable).- Throws:
WorkflowException
-
getTasks
Task[] getTasks(User user, String roleName, ProcessInstance processInstance) throws WorkflowException
Returns the tasks assigned to a user on a processInstance.- Throws:
WorkflowException
-
getCreationTask
Task getCreationTask(User user, String roleName, ProcessModel processModel) throws WorkflowException
Returns the creation task of a processModel or null if the user is not allowed to create a new instance.- Throws:
WorkflowException
-
getProcessInstanceIdFromExternalTodoId
String getProcessInstanceIdFromExternalTodoId(String externalTodoId) throws WorkflowException
Get the process instance Id referred by the task to do with the given identifier.- Throws:
WorkflowException
-
getRoleNameFromExternalTodoId
String getRoleNameFromExternalTodoId(String externalTodoId) throws WorkflowException
Get the role name of task referred by the task to do with the given identifier- Throws:
WorkflowException
-
notifyActor
void notifyActor(Task task, User sender, Actor user, String text, boolean linkDisabled) throws WorkflowException
Notify user that an action has been done- Throws:
WorkflowException
-
-