com.whitestein.lsps.human.task

Class BaseTodoTask

java.lang.Object

com.whitestein.lsps.human.task.BaseTodoTask

All Implemented Interfaces:

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

Direct Known Subclasses:

CustomUIUserTask, UserTask

@PermitAll
public abstract class BaseTodoTask
extends java.lang.Object
implements com.whitestein.lsps.human.task.TodoTask

Abstract class for creation of human-oriented tasks. It contains methods for creation of the to-do, waiting for to-do submission and canceling the to-do when plan is deactivated. The created to-dos are saved in a database table. The application should render the to-dos based on the to-do content. Different tasks should create to-dos with different types so that the application can use appropriate renderers.

Nested Class Summary

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

ExecutableTask.Result

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseTodoTask() Creates new instance.

Method Summary

Modifier and Type	Method and Description
protected Todo	addTodo(TaskContext context, java.lang.String type, java.io.Serializable content) Creates a to-do (calls createTodo(TaskContext, String, Serializable)) and adds the to-do to the database.
protected abstract java.io.Serializable	createContent(TaskContext context) This method should return the todo content, it is called when starting a todo-task.
protected Todo	createTodo(TaskContext context, java.lang.String type, java.io.Serializable content) Creates a to-do and sets initial values.
void	escalate(TaskContext context, java.lang.String reason) Task itself defines what is executed during escalation.
java.util.Date	getEscalationDate(TaskContext context) Returns escalation timeout
RecordHolder	getEscalationTimeout() Returns the escalation timeout.
HumanTypeFactory	getHumanHolderConverter() Returns the provided human holder converter.
ReferenceHolder	getIssuedTodo() Returns the issued todo reference.
protected ModelInstanceUtilsService	getModelInstanceUtilsService() Returns model modelInstanceUtils service
protected ModelProviderService	getModelProviderService() Returns model provider service
OrgTypeFactory	getPerformerHolderConverter() Returns the provided performer holder converter.
SetHolder	getPerformers() Returns the todo performers.
java.lang.String	getTitle() Returns the todo title.
protected Todo	getTodo(TaskContext context) Returns the todo.ui
TodoDao	getTodoDao() Returns the provided todo dao.
protected java.lang.Long	getTodoId(TaskContext context) Returns to-do id.
protected com.whitestein.lsps.human.UIImplementationType	getTodoImplementationType(java.io.Serializable content)
protected abstract java.lang.String	getType(TaskContext context) This method should return the todo-task type.
ExecutableTask.Result	processInput(TaskContext context, java.lang.Object input) The method for processing the model instance input.
protected void	processReply(TaskContext context, java.lang.Object data) Process the data submitted by the user.
protected java.lang.String	removeTodo(TaskContext context, TodoStatus status, java.lang.String interruptionReason) Sets the status of the to-do.
void	resume(TaskContext context) Called when the model instance is resumed.
ExecutableTask.Result	start(TaskContext context) An initial method that is called when the task execution starts.
void	suspend(TaskContext context) Called when the model instance is suspended.
void	terminate(TaskContext context, TerminationReason reason) Called when this task is to be terminated.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseTodoTask

protected BaseTodoTask()

Creates new instance.

Method Detail

start

public ExecutableTask.Result start(TaskContext context)
                            throws ErrorException

Description copied from interface: ExecutableTask

An initial method that is called when the task execution starts.

Specified by:

start in interface ExecutableTask

Returns:

result of execution, must not be null

Throws:

ErrorException - the BPMN error

processInput

public ExecutableTask.Result processInput(TaskContext context,
                                          java.lang.Object input)
                                   throws ErrorException

Description copied from interface: ExecutableTask

The method for processing the model instance input.

This method is invoked when a previous call to either start method or processInput method returned WAITING_FOR_INPUT and a new input is to be process by the model instance.

Specified by:

processInput in interface ExecutableTask

Returns:

result of execution, must not be null

Throws:

ErrorException - the BPMN error

getType

protected abstract java.lang.String getType(TaskContext context)

This method should return the todo-task type.

Parameters:

context -

Returns:

the todo-task type

createContent

protected abstract java.io.Serializable createContent(TaskContext context)
                                               throws ErrorException

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

Parameters:

context -

Returns:

the todo content

Throws:

ErrorException

processReply

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

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

Parameters:

context -

data -

Throws:

ErrorException

getTodoId

protected java.lang.Long getTodoId(TaskContext context)

Returns to-do id.

Parameters:

context -

Returns:

to-do id

getTodo

protected Todo getTodo(TaskContext context)

Returns the todo.ui

Parameters:

context -

Returns:

the todo

removeTodo

protected java.lang.String removeTodo(TaskContext context,
                                      TodoStatus status,
                                      java.lang.String interruptionReason)

Sets the status of the to-do.

Parameters:

context -

status -

interruptionReason -

Returns:

id of the user to whom the to-do is allocated (locked)

addTodo

protected Todo addTodo(TaskContext context,
                       java.lang.String type,
                       java.io.Serializable content)
                throws ErrorException

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

Parameters:

context -

type -

content -

Returns:

to-do

Throws:

ErrorException

createTodo

protected Todo createTodo(TaskContext context,
                          java.lang.String type,
                          java.io.Serializable content)
                   throws ErrorException

Creates a to-do and sets initial values. Can be overridden to customize the created to-do.ui

Parameters:

context -

type -

content -

Returns:

created to-do

Throws:

ErrorException

getTodoImplementationType

protected com.whitestein.lsps.human.UIImplementationType getTodoImplementationType(java.io.Serializable content)

Returns:

returns implementation type

terminate

public void terminate(TaskContext context,
                      TerminationReason reason)
               throws ErrorException

Description copied from interface: ExecutableTask

Called when this task is to be terminated. This method is called also in case of normal task completion.

Specified by:

terminate in interface ExecutableTask

Throws:

ErrorException - the BPMN error

See Also:

ErrorException

escalate

public void escalate(TaskContext context,
                     java.lang.String reason)

Description copied from interface: EscalatableTask

Task itself defines what is executed during escalation.

Specified by:

escalate in interface EscalatableTask

reason - reason of escalation

getEscalationDate

public java.util.Date getEscalationDate(TaskContext context)
                                 throws ErrorException

Description copied from interface: EscalatableTask

Returns escalation timeout

Specified by:

getEscalationDate in interface EscalatableTask

Returns:

escalation timeout

Throws:

ErrorException

suspend

public void suspend(TaskContext context)

Description copied from interface: SuspendableTask

Called when the model instance is suspended.

Specified by:

suspend in interface SuspendableTask

Parameters:

context - the task context

resume

public void resume(TaskContext context)

Description copied from interface: SuspendableTask

Called when the model instance is resumed.

Specified by:

resume in interface SuspendableTask

Parameters:

context - the task context

getTitle

public java.lang.String getTitle()

Returns the todo title.

Returns:

the todo title

getPerformers

public SetHolder getPerformers()

Returns the todo performers.

Returns:

the todo performers

getIssuedTodo

public ReferenceHolder getIssuedTodo()

Returns the issued todo reference.

Returns:

the issued todo reference

getEscalationTimeout

public RecordHolder getEscalationTimeout()

Returns the escalation timeout.

Returns:

the escalation timeout

getTodoDao

public TodoDao getTodoDao()

Returns the provided todo dao.

Returns:

the provided todo dao

getHumanHolderConverter

public HumanTypeFactory getHumanHolderConverter()

Returns the provided human holder converter.

Returns:

the provided human holder converter

getPerformerHolderConverter

public OrgTypeFactory getPerformerHolderConverter()

Returns the provided performer holder converter.

Returns:

the provided performer holder converter

getModelProviderService

protected ModelProviderService getModelProviderService()

Returns model provider service

Returns:

model provider service

getModelInstanceUtilsService

protected ModelInstanceUtilsService getModelInstanceUtilsService()

Returns model modelInstanceUtils service

Returns:

the modelInstanceUtilsService