org.egov.eis.web.actions.workflow

Class GenericWorkFlowAction

java.lang.Object

com.opensymphony.xwork2.ActionSupport

org.egov.infra.web.struts.actions.BaseFormAction

org.egov.eis.web.actions.workflow.GenericWorkFlowAction

All Implemented Interfaces:

com.opensymphony.xwork2.Action, com.opensymphony.xwork2.interceptor.ParameterNameAware, com.opensymphony.xwork2.interceptor.ValidationAware, com.opensymphony.xwork2.LocaleProvider, com.opensymphony.xwork2.ModelDriven<Object>, com.opensymphony.xwork2.Preparable, com.opensymphony.xwork2.TextProvider, com.opensymphony.xwork2.Validateable, Serializable, org.apache.struts2.interceptor.ParameterAware, org.apache.struts2.interceptor.RequestAware, org.apache.struts2.interceptor.SessionAware

public abstract class GenericWorkFlowAction
extends org.egov.infra.web.struts.actions.BaseFormAction

Generic WorkFlow Action. Can be extended by any action class that intends to provide Work flow functionality.

Author:

subhash

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	additionalRule
protected BigDecimal	amountRule
protected String	approverComments
protected String	approverDepartment
protected String	approverDesignation
protected String	approverName
protected Long	approverPositionId
protected String	currentDesignation
protected String	currentState
protected org.egov.infra.workflow.matrix.service.CustomizedWorkFlowService	customizedWorkFlowService
protected String	pendingActions
protected String	workFlowAction
protected String	workFlowDepartment

Fields inherited from class org.egov.infra.web.struts.actions.BaseFormAction

dropdownData, EDIT, INDEX, NEW, ordering, parameters, persistenceService, relations, request, VIEW

Fields inherited from class com.opensymphony.xwork2.ActionSupport

container, LOG

Fields inherited from interface com.opensymphony.xwork2.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Constructors

Constructor and Description
GenericWorkFlowAction()

Method Summary

Modifier and Type	Method and Description
protected String	getAdditionalRule() Implementations must override this method to get additional rule for workflow.
protected BigDecimal	getAmountRule() Implementations must override this method based on their object's value that needs to be used in workflow
String	getApproverComments()
String	getApproverDepartment()
String	getApproverDesignation()
String	getApproverName()
Long	getApproverPositionId()
String	getCurrentDesignation()
String	getCurrentState()
abstract org.egov.infra.workflow.entity.StateAware	getModel()
String	getNextAction() Used to get next action If the nextAction value is END then approval Information won't be shown on the UI.
protected String	getPendingActions() This parameter is used to get matrix object Implementations must override this method to get pendingActions
List<String>	getValidActions() Used to get valid actions that needs to be performed Based on these value workflow buttons will be rendered
String	getWorkFlowAction()
protected String	getWorkFlowDepartment() Implementations must override this method to achieve department wise workflow.
void	prepare()
void	setAdditionalRule(String additionalRule)
void	setAmountRule(BigDecimal amountRule)
void	setApproverComments(String approverComments)
void	setApproverDepartment(String approverDepartment)
void	setApproverDesignation(String approverDesignation)
void	setApproverName(String approverName)
void	setApproverPositionId(Long approverPositionId)
void	setCurrentDesignation(String currentDesignation)
void	setCurrentState(String currentState)
void	setCustomizedWorkFlowService(org.egov.infra.workflow.matrix.service.CustomizedWorkFlowService customizedWorkFlowService)
void	setPendingActions(String pendingActions)
void	setWorkFlowAction(String workFlowAction) Used to Set actionValue that will be used to call workflow script.
void	setWorkFlowDepartment(String workFlowDepartment)

Methods inherited from class org.egov.infra.web.struts.actions.BaseFormAction

acceptableParameterName, addDropdownData, addRelatedEntity, addRelatedEntity, getDropdownData, getOrdering, getPersistenceService, getRelationships, getSession, session, setParameters, setPersistenceService, setRequest, setSession, setupDropdownDataExcluding, setValue, tokenName

Methods inherited from class com.opensymphony.xwork2.ActionSupport

addActionError, addActionMessage, addFieldError, clearActionErrors, clearErrors, clearErrorsAndMessages, clearFieldErrors, clearMessages, clone, execute, getActionErrors, getActionMessages, getFieldErrors, getFormatted, getLocale, getText, getText, getText, getText, getText, getText, getText, getText, getText, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, hasKey, input, isValidLocale, isValidLocaleString, pause, setActionErrors, setActionMessages, setContainer, setFieldErrors, validate

Methods inherited from class java.lang.Object

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

Field Detail

customizedWorkFlowService

protected org.egov.infra.workflow.matrix.service.CustomizedWorkFlowService customizedWorkFlowService

workFlowAction

protected String workFlowAction

approverComments

protected String approverComments

currentState

protected String currentState

currentDesignation

protected String currentDesignation

additionalRule

protected String additionalRule

amountRule

protected BigDecimal amountRule

workFlowDepartment

protected String workFlowDepartment

pendingActions

protected String pendingActions

approverName

protected String approverName

approverDepartment

protected String approverDepartment

approverDesignation

protected String approverDesignation

approverPositionId

protected Long approverPositionId

Constructor Detail

GenericWorkFlowAction

public GenericWorkFlowAction()

Method Detail

getModel

public abstract org.egov.infra.workflow.entity.StateAware getModel()

prepare

public void prepare()

Specified by:

prepare in interface com.opensymphony.xwork2.Preparable

Overrides:

prepare in class org.egov.infra.web.struts.actions.BaseFormAction

getAmountRule

protected BigDecimal getAmountRule()

Implementations must override this method based on their object's value that needs to be used in workflow

Returns:

the value that needs to be compared in the Amount rule table against FromAmount and ToAmount

getAdditionalRule

protected String getAdditionalRule()

Implementations must override this method to get additional rule for workflow.

Returns:

the value that needs to be compared in the matrix table against Additional rule

getWorkFlowDepartment

protected String getWorkFlowDepartment()

Implementations must override this method to achieve department wise workflow.

Returns:

the value that needs to be compared in the matrix table against Department.

getValidActions

public List<String> getValidActions()

Used to get valid actions that needs to be performed Based on these value workflow buttons will be rendered

getNextAction

public String getNextAction()

Used to get next action If the nextAction value is END then approval Information won't be shown on the UI.

setCustomizedWorkFlowService

public void setCustomizedWorkFlowService(org.egov.infra.workflow.matrix.service.CustomizedWorkFlowService customizedWorkFlowService)

setWorkFlowAction

public void setWorkFlowAction(String workFlowAction)

Used to Set actionValue that will be used to call workflow script.

Parameters:

workFlowAction -

getPendingActions

protected String getPendingActions()

This parameter is used to get matrix object Implementations must override this method to get pendingActions

Returns:

the value needs to be compared against matrix table pendingActions

getApproverComments

public String getApproverComments()

setApproverComments

public void setApproverComments(String approverComments)

getCurrentState

public String getCurrentState()

setCurrentState

public void setCurrentState(String currentState)

getCurrentDesignation

public String getCurrentDesignation()

setCurrentDesignation

public void setCurrentDesignation(String currentDesignation)

getApproverName

public String getApproverName()

setApproverName

public void setApproverName(String approverName)

getApproverDepartment

public String getApproverDepartment()

setApproverDepartment

public void setApproverDepartment(String approverDepartment)

getApproverDesignation

public String getApproverDesignation()

setApproverDesignation

public void setApproverDesignation(String approverDesignation)

getApproverPositionId

public Long getApproverPositionId()

setApproverPositionId

public void setApproverPositionId(Long approverPositionId)

getWorkFlowAction

public String getWorkFlowAction()

setAdditionalRule

public void setAdditionalRule(String additionalRule)

setAmountRule

public void setAmountRule(BigDecimal amountRule)

setWorkFlowDepartment

public void setWorkFlowDepartment(String workFlowDepartment)

setPendingActions

public void setPendingActions(String pendingActions)