org.egov.infra.web.struts.actions.workflow

Class GenericWorkFlowAction

java.lang.Object

com.opensymphony.xwork2.ActionSupport

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

org.egov.infra.web.struts.actions.SearchFormAction

org.egov.infra.web.struts.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 SearchFormAction

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	approverComments
protected CustomizedWorkFlowService	customizedWorkFlowService
protected String	workFlowAction

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

searchResult

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

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

Fields inherited from class com.opensymphony.xwork2.ActionSupport

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()
abstract 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
protected String	getWorkFlowDepartment() Implementations must override this method to achieve department wise workflow.
void	prepare()
SearchQuery	prepareQuery(String sortField, String sortOrder)
void	setApproverComments(String approverComments)
void	setCustomizedWorkFlowService(CustomizedWorkFlowService customizedWorkFlowService)
void	setWorkFlowAction(String workFlowAction) Used to Set actionValue that will be used to call workflow script.

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

getDir, getPage, getPageSize, getSearchResult, getSort, getSortDir, search, setDir, setPage, setPageSize, setSort, setSortDir, setTableId

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, 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 CustomizedWorkFlowService customizedWorkFlowService

workFlowAction

protected String workFlowAction

approverComments

protected String approverComments

Constructor Detail

GenericWorkFlowAction

public GenericWorkFlowAction()

Method Detail

getModel

public abstract StateAware getModel()

prepareQuery

public SearchQuery prepareQuery(String sortField,
                                String sortOrder)

Specified by:

prepareQuery in class SearchFormAction

Parameters:

sortField - the field on which data is to be sorted. This will be same as the value of "property" attribute in display:column tag (when sortable=true and user clicks on the column to sort it). In case no sorting is required, this parameter will be passed as null.

sortOrder - the sort order (asc/desc)

Returns:

the query to be used for fetching the search results.

prepare

public void prepare()

Specified by:

prepare in interface com.opensymphony.xwork2.Preparable

Overrides:

prepare in class 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(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)