org.egov.infra.workflow.service

Interface WorkflowService<T extends StateAware>

Type Parameters:

T - the generic type

All Known Implementing Classes:

SimpleWorkflowService

public interface WorkflowService<T extends StateAware>

The Interface WorkflowService.

Method Summary

Modifier and Type	Method and Description
List<WorkflowAction>	getValidActions(T stateAware) Returns a set of valid actions that can be executed on the stateAware.
WorkFlowMatrix	getWfMatrix(String type, String department, BigDecimal amountRule, String additionalRule, String currentState, String pendingAction) Returns WorkFlowMatrix for following combination of arguments
WorkFlowMatrix	getWfMatrix(String type, String department, BigDecimal amountRule, String additionalRule, String currentState, String pendingAction, Date date) Returns WorkFlowMatrix for following combination of arguments
WorkFlowMatrix	getWfMatrix(String type, String department, BigDecimal amountRule, String additionalRule, String currentState, String pendingAction, Date date, String designation) Returns WorkFlowMatrix for following combination of arguments
T	transition(String actionName, T stateAware, String comment) Moves the stateAware from the current state to the next state.
T	transition(WorkflowAction workflowAction, T stateAware, String comment) Moves the stateAware from the current state to the next state.

Method Detail

transition

T transition(WorkflowAction workflowAction,
             T stateAware,
             String comment)

Moves the stateAware from the current state to the next state. The actual logic of moving the stateAware depends on the state of the stateAware, and the Action

Parameters:

workflowAction - the action

stateAware - the state aware stateAware

comment - the comment

Returns:

stateAware after state transition.

transition

T transition(String actionName,
             T stateAware,
             String comment)

Moves the stateAware from the current state to the next state. The actual logic of moving the stateAware depends on the state of the stateAware, the Action and the corresponding business rules encapsulated in a Script. The script name should be '.workflow.'. If this script was not found, the implementation will look for a script named '.workflow'. If this is not found either, then an EgovRuntimeException is thrown with the message key as 'workflow.script.notfound'

Parameters:

actionName - the action name

stateAware - the state aware stateAware

comment - the comment

Returns:

stateAware after state transition.

getValidActions

List<WorkflowAction> getValidActions(T stateAware)

Returns a set of valid actions that can be executed on the stateAware. The actions are determined using the current state of the stateAware

Parameters:

stateAware - the state aware

Returns:

List of valid Actions

getWfMatrix

WorkFlowMatrix getWfMatrix(String type,
                           String department,
                           BigDecimal amountRule,
                           String additionalRule,
                           String currentState,
                           String pendingAction)

Returns WorkFlowMatrix for following combination of arguments

Parameters:

type - the Object type of object

department - Name of the department

amountRule - the amount

additionalRule - the additional rule defined for the objecttype

currentState - the current state of the object

pendingAction - the pendingActions for the objecttype

Returns:

WorkFlowMatrix Object

getWfMatrix

WorkFlowMatrix getWfMatrix(String type,
                           String department,
                           BigDecimal amountRule,
                           String additionalRule,
                           String currentState,
                           String pendingAction,
                           Date date)

Returns WorkFlowMatrix for following combination of arguments

Parameters:

type - the Object type of object

department - Name of the department

amountRule - the amount

additionalRule - the additional rule defined for the objecttype

currentState - the current state of the object

pendingAction - the pendingActions for the objecttype

Returns:

WorkFlowMatrix Object

getWfMatrix

WorkFlowMatrix getWfMatrix(String type,
                           String department,
                           BigDecimal amountRule,
                           String additionalRule,
                           String currentState,
                           String pendingAction,
                           Date date,
                           String designation)

Returns WorkFlowMatrix for following combination of arguments

Parameters:

type - the Object type of object

department - Name of the department

amountRule - the amount

additionalRule - the additional rule defined for the objecttype

currentState - the current state of the object

pendingAction - the pendingActions for the objecttype

date -

designation - of user

Returns:

WorkFlowMatrix Object