com.technia.tvc.collaboration.workflow

Class DefaultWorkflowEngine

java.lang.Object

com.technia.tvc.collaboration.workflow.DefaultWorkflowEngine

All Implemented Interfaces:

WorkflowEngine

public class DefaultWorkflowEngine
extends java.lang.Object

This class contains the logic of the workflow such as progress when approving, completing or rejecting. Triggering events as something happens. Controlling due dates. Reassignment etc.

Since:

2015.3.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	com.technia.tvc.collaboration.workflow.WorkflowEngineUtil.EngineAction

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.Collection<TaskStatus>	COMPLETE_STATUSES

Constructor Summary

Constructors

Constructor and Description
DefaultWorkflowEngine()

Method Summary

Modifier and Type	Method and Description
protected void	activate(EngineResult.Builder result, WorkflowContext wctx, java.util.Collection<Task> tasks)
protected void	activate(EngineResult.Builder result, WorkflowContext wctx, TaskContext tctx)
EngineResult	activate(WorkflowContext wctx, TaskContext tctx)
protected void	addTask(EngineResult.Builder result, WorkflowContext wctx, TaskContext tctx)
EngineResult	addTask(WorkflowContext wctx, TaskContext tctx)
protected void	alert(EngineResult.Builder arg0, WorkflowContext arg1, Task arg2, java.util.Collection<Person> arg3, RecipientType arg4)
EngineResult	alert(WorkflowContext wctx, AlertContext actx)
protected void	alertTask(EngineResult.Builder arg0, WorkflowContext arg1, Task arg2)
protected void	alertTasks(EngineResult.Builder arg0, WorkflowContext arg1, java.util.Collection<Task> arg2)
protected void	alertWatcher(EngineResult.Builder arg0, WorkflowContext arg1, Task arg2)
protected void	alertWatchers(EngineResult.Builder arg0, WorkflowContext arg1, java.util.Collection<Task> arg2)
protected void	alertWorkflow(EngineResult.Builder arg0, WorkflowContext arg1)
protected void	approve(EngineResult.Builder result, WorkflowContext wctx, TaskContext tctx)
EngineResult	approve(WorkflowContext wctx, TaskContext tctx)
protected void	assign(EngineResult.Builder result, WorkflowContext wctx, TaskContext tctx)
EngineResult	assign(WorkflowContext wctx, TaskContext tctx)
protected boolean	canActivate(Workflow arg0, Task arg1)
protected boolean	canCompleteFlow(Workflow arg0, Task arg1)
protected void	commit(EngineResult.Builder arg0, WorkflowContext arg1)
protected void	complete(EngineResult.Builder result, WorkflowContext wctx, TaskContext tctx)
protected void	complete(EngineResult.Builder result, WorkflowContext wctx, WorkflowStatus status)
EngineResult	complete(WorkflowContext wctx, TaskContext tctx)
EngineResult	createTask(WorkflowContext wctx, TaskContext tctx)
protected void	createTaskBusinessObject(WorkflowContext wctx, TaskContext tctx)
EngineResult	createWorkflow(WorkflowContext wctx)
protected void	deleteTask(EngineResult.Builder result, WorkflowContext wctx, TaskContext tctx)
EngineResult	deleteTask(WorkflowContext wctx, TaskContext tctx)
protected EngineResult	execute(EngineResult.Builder arg0, WorkflowContext arg1, TaskContext arg2, com.technia.tvc.collaboration.workflow.WorkflowEngineUtil.EngineAction arg3)
protected java.lang.String	findDelegate(java.lang.String arg0, java.util.Collection<java.lang.String> arg1)
protected java.util.Date	getDue(TaskCfg arg0)
protected WorkflowDAOFactory	getFactory()
protected java.util.Collection<Identifier>	getPreviousRevisions(Workflow arg0, Identifier arg1)
protected boolean	hasParallel(java.util.Collection<Task> arg0, Workflow arg1, java.lang.String arg2)
protected boolean	hasReopen(Workflow arg0)
protected boolean	isCompleted(java.util.Collection<Task> arg0)
protected boolean	isParallel(Task arg0, Workflow arg1)
protected boolean	isProgressable(Task arg0, Workflow arg1)
protected boolean	isReopenable(Task arg0, Workflow arg1)
protected void	pending(EngineResult.Builder arg0, WorkflowContext arg1, java.util.Collection<Task> arg2)
protected void	progress(EngineResult.Builder result, WorkflowContext wctx, Task task)
protected void	reassign(EngineResult.Builder result, WorkflowContext wctx, TaskContext tctx)
EngineResult	reassign(WorkflowContext wctx, TaskContext tctx)
protected void	reassignTasks(EngineResult.Builder result, WorkflowContext wctx, java.util.Collection<TaskContext> tctxs)
EngineResult	reassignTasks(WorkflowContext wctx, java.util.Collection<TaskContext> tctxs)
protected void	reject(EngineResult.Builder result, WorkflowContext wctx, TaskContext tctx)
EngineResult	reject(WorkflowContext wctx, TaskContext tctx)
EngineResult	restart(WorkflowContext wctx)
protected void	revise(EngineResult.Builder result, WorkflowContext wctx, java.util.Collection<Task> tasks)
EngineResult	revise(WorkflowContext wctx, TaskContext tctx)
protected Task	reviseTask(WorkflowContext wctx, TaskContext tctx)
protected void	runActionTriggers(EngineResult.Builder arg0, WorkflowContext arg1, Task arg2, java.util.Collection<Field> arg3)
protected void	runCheckTriggers(EngineResult.Builder arg0, WorkflowContext arg1, Task arg2, java.util.Collection<Field> arg3)
protected java.util.Collection<TriggerResult>	runTriggers(java.util.Collection<? extends TriggerCfg> arg0, TriggerContext arg1, Workflow arg2, Task arg3)
protected java.util.Collection<TriggerResult>	runTriggers(WorkflowContext arg0, java.util.Collection<Field> arg1)
protected java.util.Collection<TriggerResult>	runTriggers(WorkflowContext arg0, Task arg1, java.util.Collection<Field> arg2, boolean arg3)
protected void	setDue(Task arg0)
protected void	setDueDate(EngineResult.Builder result, WorkflowContext wctx, TaskContext tctx)
EngineResult	setDueDate(WorkflowContext wctx, TaskContext tctx)
EngineResult	start(WorkflowContext wctx)
protected void	stop(EngineResult.Builder result, WorkflowContext wctx)
EngineResult	stop(WorkflowContext wctx)
protected void	terminate(EngineResult.Builder result, WorkflowContext wctx)
EngineResult	terminate(WorkflowContext wctx)
protected void	throwIfError(EngineResult.Builder arg0)
protected ActionStatus	toActionStatus(TriggerStatus arg0)
protected EngineResult	toEngineResult(java.util.Collection<TriggerResult> arg0)
protected EngineResult	toEngineResult(java.util.Collection<TriggerResult> arg0, java.util.Collection<Notification> arg1)
protected TaskContext	toTaskContext(Task arg0, Component arg1, WorkflowContext arg2)
protected TaskContext	toTaskContext(Task arg0, TaskContext arg1)
protected TaskContext	toTaskContext(Task arg0, WorkflowContext arg1)
protected TaskContext	toTaskContextWithFields(Task arg0, TaskContext arg1)
protected TaskContext	toTaskContextWithRetainableFields(Workflow arg0, TaskContext arg1)
protected UpdateContext	toUpdateContext(WorkflowContext arg0)
protected void	update(EngineResult.Builder result, WorkflowContext wctx, TaskContext tctx)
protected void	update(TaskContext arg0)
EngineResult	update(WorkflowContext wctx, TaskContext tctx)
protected void	updateIfDelegated(Task arg0)
protected void	validate(EngineResult.Builder arg0, WorkflowContext arg1, Task arg2)

Methods inherited from class java.lang.Object

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

Field Detail

COMPLETE_STATUSES

protected static final java.util.Collection<TaskStatus> COMPLETE_STATUSES

Constructor Detail

DefaultWorkflowEngine

public DefaultWorkflowEngine()

Method Detail

createTask

public EngineResult createTask(WorkflowContext wctx,
                               TaskContext tctx)
                        throws TVCException

Throws:

TVCException

createTaskBusinessObject

protected void createTaskBusinessObject(WorkflowContext wctx,
                                        TaskContext tctx)
                                 throws TVCException

Throws:

TVCException

createWorkflow

public EngineResult createWorkflow(WorkflowContext wctx)
                            throws TVCException

Throws:

TVCException

revise

public EngineResult revise(WorkflowContext wctx,
                           TaskContext tctx)
                    throws TVCException

Throws:

TVCException

reviseTask

protected Task reviseTask(WorkflowContext wctx,
                          TaskContext tctx)
                   throws TVCException

Throws:

TVCException

start

public EngineResult start(WorkflowContext wctx)
                   throws TVCException

Throws:

TVCException

activate

protected void activate(EngineResult.Builder result,
                        WorkflowContext wctx,
                        java.util.Collection<Task> tasks)
                 throws TVCException

Throws:

TVCException

stop

public EngineResult stop(WorkflowContext wctx)
                  throws TVCException

Throws:

TVCException

stop

protected void stop(EngineResult.Builder result,
                    WorkflowContext wctx)
             throws TVCException

Throws:

TVCException

terminate

public EngineResult terminate(WorkflowContext wctx)
                       throws TVCException

Throws:

TVCException

terminate

protected void terminate(EngineResult.Builder result,
                         WorkflowContext wctx)
                  throws TVCException

Throws:

TVCException

complete

protected void complete(EngineResult.Builder result,
                        WorkflowContext wctx,
                        WorkflowStatus status)
                 throws TVCException

Throws:

TVCException

restart

public EngineResult restart(WorkflowContext wctx)
                     throws TVCException

Throws:

TVCException

activate

public EngineResult activate(WorkflowContext wctx,
                             TaskContext tctx)
                      throws TVCException

Throws:

TVCException

activate

protected void activate(EngineResult.Builder result,
                        WorkflowContext wctx,
                        TaskContext tctx)
                 throws TVCException

Throws:

TVCException

approve

public EngineResult approve(WorkflowContext wctx,
                            TaskContext tctx)
                     throws TVCException

Throws:

TVCException

approve

protected void approve(EngineResult.Builder result,
                       WorkflowContext wctx,
                       TaskContext tctx)
                throws TVCException

Throws:

TVCException

complete

public EngineResult complete(WorkflowContext wctx,
                             TaskContext tctx)
                      throws TVCException

Throws:

TVCException

complete

protected void complete(EngineResult.Builder result,
                        WorkflowContext wctx,
                        TaskContext tctx)
                 throws TVCException

Throws:

TVCException

reject

public EngineResult reject(WorkflowContext wctx,
                           TaskContext tctx)
                    throws TVCException

Throws:

TVCException

reject

protected void reject(EngineResult.Builder result,
                      WorkflowContext wctx,
                      TaskContext tctx)
               throws TVCException

Throws:

TVCException

reassign

public EngineResult reassign(WorkflowContext wctx,
                             TaskContext tctx)
                      throws TVCException

Throws:

TVCException

reassign

protected void reassign(EngineResult.Builder result,
                        WorkflowContext wctx,
                        TaskContext tctx)
                 throws TVCException

Throws:

TVCException

setDueDate

public EngineResult setDueDate(WorkflowContext wctx,
                               TaskContext tctx)
                        throws TVCException

Throws:

TVCException

setDueDate

protected void setDueDate(EngineResult.Builder result,
                          WorkflowContext wctx,
                          TaskContext tctx)
                   throws TVCException

Throws:

TVCException

assign

public EngineResult assign(WorkflowContext wctx,
                           TaskContext tctx)
                    throws TVCException

Throws:

TVCException

assign

protected void assign(EngineResult.Builder result,
                      WorkflowContext wctx,
                      TaskContext tctx)
               throws TVCException

Throws:

TVCException

update

public EngineResult update(WorkflowContext wctx,
                           TaskContext tctx)
                    throws TVCException

Throws:

TVCException

update

protected void update(EngineResult.Builder result,
                      WorkflowContext wctx,
                      TaskContext tctx)
               throws TVCException

Throws:

TVCException

revise

protected void revise(EngineResult.Builder result,
                      WorkflowContext wctx,
                      java.util.Collection<Task> tasks)
               throws TVCException

Throws:

TVCException

progress

protected void progress(EngineResult.Builder result,
                        WorkflowContext wctx,
                        Task task)
                 throws TVCException

Throws:

TVCException

addTask

public EngineResult addTask(WorkflowContext wctx,
                            TaskContext tctx)
                     throws TVCException

Throws:

TVCException

addTask

protected void addTask(EngineResult.Builder result,
                       WorkflowContext wctx,
                       TaskContext tctx)
                throws TVCException

Throws:

TVCException

deleteTask

public EngineResult deleteTask(WorkflowContext wctx,
                               TaskContext tctx)
                        throws TVCException

Throws:

TVCException

deleteTask

protected void deleteTask(EngineResult.Builder result,
                          WorkflowContext wctx,
                          TaskContext tctx)
                   throws TVCException

Throws:

TVCException

alert

public EngineResult alert(WorkflowContext wctx,
                          AlertContext actx)

reassignTasks

public EngineResult reassignTasks(WorkflowContext wctx,
                                  java.util.Collection<TaskContext> tctxs)
                           throws TVCException

Throws:

TVCException

reassignTasks

protected void reassignTasks(EngineResult.Builder result,
                             WorkflowContext wctx,
                             java.util.Collection<TaskContext> tctxs)
                      throws TVCException

Throws:

TVCException

getFactory

protected WorkflowDAOFactory getFactory()

toUpdateContext

protected UpdateContext toUpdateContext(WorkflowContext arg0)

toTaskContextWithFields

protected TaskContext toTaskContextWithFields(Task arg0,
                                              TaskContext arg1)

toTaskContextWithRetainableFields

protected TaskContext toTaskContextWithRetainableFields(Workflow arg0,
                                                        TaskContext arg1)

toTaskContext

protected TaskContext toTaskContext(Task arg0,
                                    TaskContext arg1)

toTaskContext

protected TaskContext toTaskContext(Task arg0,
                                    WorkflowContext arg1)

toTaskContext

protected TaskContext toTaskContext(Task arg0,
                                    Component arg1,
                                    WorkflowContext arg2)

setDue

protected void setDue(Task arg0)
               throws TVCException

Throws:

TVCException

throwIfError

protected void throwIfError(EngineResult.Builder arg0)
                     throws TVCException

Throws:

TVCException

commit

protected void commit(EngineResult.Builder arg0,
                      WorkflowContext arg1)
               throws TVCException

Throws:

TVCException

getDue

protected java.util.Date getDue(TaskCfg arg0)

hasReopen

protected boolean hasReopen(Workflow arg0)

isReopenable

protected boolean isReopenable(Task arg0,
                               Workflow arg1)

pending

protected void pending(EngineResult.Builder arg0,
                       WorkflowContext arg1,
                       java.util.Collection<Task> arg2)
                throws TVCException

Throws:

TVCException

canCompleteFlow

protected boolean canCompleteFlow(Workflow arg0,
                                  Task arg1)

isProgressable

protected boolean isProgressable(Task arg0,
                                 Workflow arg1)

isCompleted

protected boolean isCompleted(java.util.Collection<Task> arg0)

runActionTriggers

protected void runActionTriggers(EngineResult.Builder arg0,
                                 WorkflowContext arg1,
                                 Task arg2,
                                 java.util.Collection<Field> arg3)
                          throws TVCException

Throws:

TVCException

runCheckTriggers

protected void runCheckTriggers(EngineResult.Builder arg0,
                                WorkflowContext arg1,
                                Task arg2,
                                java.util.Collection<Field> arg3)
                         throws TVCException

Throws:

TVCException

toEngineResult

protected EngineResult toEngineResult(java.util.Collection<TriggerResult> arg0)

toActionStatus

protected ActionStatus toActionStatus(TriggerStatus arg0)

toEngineResult

protected EngineResult toEngineResult(java.util.Collection<TriggerResult> arg0,
                                      java.util.Collection<Notification> arg1)

runTriggers

protected java.util.Collection<TriggerResult> runTriggers(WorkflowContext arg0,
                                                          java.util.Collection<Field> arg1)
                                                   throws TVCException

Throws:

TVCException

runTriggers

protected java.util.Collection<TriggerResult> runTriggers(WorkflowContext arg0,
                                                          Task arg1,
                                                          java.util.Collection<Field> arg2,
                                                          boolean arg3)
                                                   throws TVCException

Throws:

TVCException

runTriggers

protected java.util.Collection<TriggerResult> runTriggers(java.util.Collection<? extends TriggerCfg> arg0,
                                                          TriggerContext arg1,
                                                          Workflow arg2,
                                                          Task arg3)
                                                   throws TVCException

Throws:

TVCException

alertWorkflow

protected void alertWorkflow(EngineResult.Builder arg0,
                             WorkflowContext arg1)
                      throws TVCException

Throws:

TVCException

alertWatcher

protected void alertWatcher(EngineResult.Builder arg0,
                            WorkflowContext arg1,
                            Task arg2)
                     throws TVCException

Throws:

TVCException

alertTask

protected void alertTask(EngineResult.Builder arg0,
                         WorkflowContext arg1,
                         Task arg2)
                  throws TVCException

Throws:

TVCException

alertTasks

protected void alertTasks(EngineResult.Builder arg0,
                          WorkflowContext arg1,
                          java.util.Collection<Task> arg2)
                   throws TVCException

Throws:

TVCException

alertWatchers

protected void alertWatchers(EngineResult.Builder arg0,
                             WorkflowContext arg1,
                             java.util.Collection<Task> arg2)
                      throws TVCException

Throws:

TVCException

alert

protected void alert(EngineResult.Builder arg0,
                     WorkflowContext arg1,
                     Task arg2,
                     java.util.Collection<Person> arg3,
                     RecipientType arg4)

canActivate

protected boolean canActivate(Workflow arg0,
                              Task arg1)

execute

protected EngineResult execute(EngineResult.Builder arg0,
                               WorkflowContext arg1,
                               TaskContext arg2,
                               com.technia.tvc.collaboration.workflow.WorkflowEngineUtil.EngineAction arg3)
                        throws TVCException

Throws:

TVCException

validate

protected void validate(EngineResult.Builder arg0,
                        WorkflowContext arg1,
                        Task arg2)
                 throws TVCException

Throws:

TVCException

update

protected void update(TaskContext arg0)

updateIfDelegated

protected void updateIfDelegated(Task arg0)

findDelegate

protected java.lang.String findDelegate(java.lang.String arg0,
                                        java.util.Collection<java.lang.String> arg1)
                                 throws TVCException

Throws:

TVCException

getPreviousRevisions

protected java.util.Collection<Identifier> getPreviousRevisions(Workflow arg0,
                                                                Identifier arg1)

isParallel

protected boolean isParallel(Task arg0,
                             Workflow arg1)

hasParallel

protected boolean hasParallel(java.util.Collection<Task> arg0,
                              Workflow arg1,
                              java.lang.String arg2)