com.whitestein.lsps.human.task

Class UserTask

java.lang.Object

com.whitestein.lsps.human.task.BaseTodoTask

com.whitestein.lsps.human.task.UserTask

All Implemented Interfaces:

EscalatableTask, ExecutableTask, SuspendableTask, com.whitestein.lsps.human.task.TodoTask

Direct Known Subclasses:

CustomUIWithContextUserTask

@PermitAll
public class UserTask
extends BaseTodoTask
implements com.whitestein.lsps.human.task.TodoTask

Generic user task for presenting information to users and to collecting their input. This task gives the application the access to the task context and whole model instance context. The application can then render the resulting to-do depending on the task parameters.

The content of the to-do will be a TodoEvaluationContent, the application is expected to pass marshalled model instance state (see ModelInstanceMarshaller.storeState(ModelInstance, com.whitestein.lsps.engine.state.MarshallerConfig)) when submitting UserTask to-dos. When the to-do is submitted, the task will attach changes done in the evaluation context and will merge them to the model instance state.

Author:

bhl

Nested Class Summary

Nested classes/interfaces inherited from interface com.whitestein.lsps.engine.ExecutableTask

ExecutableTask.Result

Constructor Summary

Constructors

Constructor and Description
UserTask()

Method Summary

Modifier and Type	Method and Description
protected Todo	addTodo(TaskContext context, String type, Serializable content) Creates a to-do (calls BaseTodoTask.createTodo(TaskContext, String, Serializable)) and adds the to-do to the database.
protected Serializable	createContent(TaskContext context) This method should return the todo content, it is called when starting a todo-task.
protected String	getType(TaskContext context) This method should return the todo-task type.
protected void	processReply(TaskContext context, Object data) Process the data submitted by the user.

Methods inherited from class com.whitestein.lsps.human.task.BaseTodoTask

createTodo, escalate, getEscalationDate, getEscalationTimeout, getHumanHolderConverter, getIssuedTodo, getModelInstanceUtilsService, getModelProviderService, getPerformerHolderConverter, getPerformers, getTitle, getTodo, getTodoDao, getTodoId, getTodoImplementationType, processInput, removeTodo, resume, start, suspend, terminate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.whitestein.lsps.engine.ExecutableTask

processInput, start, terminate

Methods inherited from interface com.whitestein.lsps.engine.EscalatableTask

escalate, getEscalationDate

Methods inherited from interface com.whitestein.lsps.engine.SuspendableTask

resume, suspend

Constructor Detail

UserTask

public UserTask()

Method Detail

getType

protected String getType(TaskContext context)

Description copied from class: BaseTodoTask

This method should return the todo-task type.

Specified by:

getType in class BaseTodoTask

Returns:

the todo-task type

createContent

protected Serializable createContent(TaskContext context)

Description copied from class: BaseTodoTask

This method should return the todo content, it is called when starting a todo-task.

Specified by:

createContent in class BaseTodoTask

Returns:

the todo content

addTodo

protected Todo addTodo(TaskContext context,
                       String type,
                       Serializable content)
                throws ErrorException

Description copied from class: BaseTodoTask

Creates a to-do (calls BaseTodoTask.createTodo(TaskContext, String, Serializable)) and adds the to-do to the database.

Overrides:

addTodo in class BaseTodoTask

Returns:

to-do

Throws:

ErrorException

processReply

protected void processReply(TaskContext context,
                            Object data)
                     throws ErrorException

Description copied from class: BaseTodoTask

Process the data submitted by the user. Default implementation does nothing.

Overrides:

processReply in class BaseTodoTask

Throws:

ErrorException