Package org.silverpeas.core.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 Detail

      • getUser

        User getUser()
        Returns the actor.

      • getUserRoleName

        String getUserRoleName()
        Returns the name of the role required for the user to have the responsibility of this task.

      • 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