com.silverpeas.workflow.api.task
Interface Task

All Known Implementing Classes:

AbstractTaskImpl, CreationTaskImpl, TaskImpl

public interface Task

A task object is an activity description built by the workflow engine and sent via the taskManager to an external system which will notify the end user and manage the task realisation. Task objects will be created by the workflow engine when a new task is assigned to a user. Task objects will be created too for the ProcessManager GUI which will be used by the user to do the assigned activity.

Method Summary

QuestionEvent	buildQuestionEvent(String stepId, DataRecord data) When this Question is asked for a task, builds a QuestionEvent giving the choosed step that must give the answer.
ResponseEvent	buildResponseEvent(String questionId, DataRecord data) When this Response is answer for a task, builds a ResponseEvent giving the question id that must give the answer.
TaskDoneEvent	buildTaskDoneEvent(String actionName, DataRecord data) When this Task is done, builds a TaskDoneEvent giving the choosed action name and the filled form.
TaskSavedEvent	buildTaskSavedEvent(String actionName, DataRecord data) When this Task is saved, builds a TaskSavedEvent giving the choosed action name and the filled form.
String[]	getActionNames() Returns the action names list from which the user must choose to resolve the activity.
HistoryStep[]	getBackSteps() Returns the history steps that user can discussed (ask a question to the actor of that step).
String	getGroupId()
Question[]	getPendingQuestions() Returns the question that must be answered
ProcessInstance	getProcessInstance() Returns the process instance.
ProcessModel	getProcessModel() Returns the process model (peas).
Question[]	getRelevantQuestions() Returns the (non onsolete) questions that have been answered
Question[]	getSentQuestions() Returns the question that have been asked and are waiting for a response
State	getState() Returns the state/activity to be resolved by the user.
User	getUser() Returns the actor.
String	getUserRoleName() Returns the name of the role which gived the responsability of this task to the user.
void	setProcessInstance(ProcessInstance currentProcessInstance) Set process instance associated with task

Method Detail

getUser

User getUser()

Returns the actor.

getUserRoleName

String getUserRoleName()

Returns the name of the role which gived the responsability of this task to the user.

getGroupId

String getGroupId()

getProcessModel

ProcessModel getProcessModel()

Returns the process model (peas). The id of this workflow internal information must be stored by the external system to be sent to the workflow engine when the activity is done.

getProcessInstance

ProcessInstance getProcessInstance()

Returns the process instance. The id of this workflow internal information must be stored by the external system to be sent to the workflow engine when the activity is done.

getState

State getState()

Returns the state/activity to be resolved by the user. The name of this workflow internal information must be stored by the external system to be sent to the workflow engine when the activity is done.

getBackSteps

HistoryStep[] getBackSteps()

Returns the history steps that user can discussed (ask a question to the actor of that step).

getPendingQuestions

Question[] getPendingQuestions()

Returns the question that must be answered

getRelevantQuestions

Question[] getRelevantQuestions()

Returns the (non onsolete) questions that have been answered

getSentQuestions

Question[] getSentQuestions()

Returns the question that have been asked and are waiting for a response

getActionNames

String[] getActionNames()

Returns the action names list from which the user must choose to resolve the activity.

buildTaskDoneEvent

TaskDoneEvent buildTaskDoneEvent(String actionName,
                                 DataRecord data)

When this Task is done, builds a TaskDoneEvent giving the choosed action name and the filled form.

buildTaskSavedEvent

TaskSavedEvent buildTaskSavedEvent(String actionName,
                                   DataRecord data)

When this Task is saved, builds a TaskSavedEvent giving the choosed action name and the filled form.

buildQuestionEvent

QuestionEvent buildQuestionEvent(String stepId,
                                 DataRecord data)

When this Question is asked for a task, builds a QuestionEvent giving the choosed step that must give the answer.

buildResponseEvent

ResponseEvent buildResponseEvent(String questionId,
                                 DataRecord data)

When this Response is answer for a task, builds a ResponseEvent giving the question id that must give the answer.

setProcessInstance

void setProcessInstance(ProcessInstance currentProcessInstance)

Set process instance associated with task