org.egov.collection.web.actions.receipts

Class CollectionsWorkflowAction

java.lang.Object

com.opensymphony.xwork2.ActionSupport

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

org.egov.collection.web.actions.receipts.CollectionsWorkflowAction

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 class CollectionsWorkflowAction
extends org.egov.infra.web.struts.actions.BaseFormAction

Action class for "Approve Collections"

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	SUBMISSION_REPORT_CASH Result for cash submission report (redirects to the cash collection report)
protected static String	SUBMISSION_REPORT_CHEQUE Result for cheque submission report (redirects to the cheque collection report)

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
CollectionsWorkflowAction() Constructor

Method Summary

Modifier and Type	Method and Description
String	approveAllCollections()
String	approveCollections() Action method to approve the selected receipt headers
Boolean	getAllowPartialSelection()
String	getApproverName()
BigDecimal	getBankAmount()
BigDecimal	getCardAmount()
BigDecimal	getCashAmount()
BigDecimal	getChequeAmount()
Long	getCounterId()
BigDecimal	getDdAmount()
String	getInboxItemDetails()
Boolean	getIsApproveAction()
Boolean	getIsRejectAction()
Boolean	getIsSubmitAction()
Object	getModel()
String	getReceiptDate()
List<org.egov.collection.entity.ReceiptHeader>	getReceiptHeaders()
String	getServiceCode()
BigDecimal	getTotalAmount()
String	getUserName()
String	listWorkflow() Action that will be called from the workflow inbox.
String	rejectCollections() Action method to reject the selected receipt headers
void	setApproverName(String approverName)
void	setCollectionsUtil(org.egov.collection.utils.CollectionsUtil collectionsUtil)
void	setCounterId(Long counterId)
void	setInboxItemDetails(String inboxItemDetails) This method is called when user clicks on a collections work flow item in the inbox.
void	setReceiptDate(String receiptDate)
void	setReceiptHeaderService(org.egov.collection.service.ReceiptHeaderService receiptHeaderService)
void	setReceiptIds(Long[] receiptIds)
void	setRemarks(String remarks)
void	setServiceCode(String serviceCode)
void	setUserName(String userName)
void	setWfAction(String wfAction)
String	submissionReportCash() Action for creating cash submission report
String	submissionReportCheque() Action for creating cash submission report
String	submitAllCollections()
String	submitCollections() Action method to submit the selected receipt headers

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

acceptableParameterName, addDropdownData, addRelatedEntity, addRelatedEntity, getDropdownData, getOrdering, getPersistenceService, getRelationships, getSession, prepare, 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

SUBMISSION_REPORT_CASH

protected static final String SUBMISSION_REPORT_CASH

Result for cash submission report (redirects to the cash collection report)

See Also:

Constant Field Values

SUBMISSION_REPORT_CHEQUE

protected static final String SUBMISSION_REPORT_CHEQUE

Result for cheque submission report (redirects to the cheque collection report)

See Also:

Constant Field Values

Constructor Detail

CollectionsWorkflowAction

public CollectionsWorkflowAction()

Constructor

Method Detail

setWfAction

public void setWfAction(String wfAction)

getInboxItemDetails

public String getInboxItemDetails()

setInboxItemDetails

public void setInboxItemDetails(String inboxItemDetails)

This method is called when user clicks on a collections work flow item in the inbox. The inbox item details contains the next work flow action to be performed, service code, user id and counter id in the following form: -servicecode-username-counterid

Parameters:

inboxItemDetails - the id to set

setCollectionsUtil

public void setCollectionsUtil(org.egov.collection.utils.CollectionsUtil collectionsUtil)

Parameters:

collectionsUtil - the collectionsUtil to set

setReceiptHeaderService

public void setReceiptHeaderService(org.egov.collection.service.ReceiptHeaderService receiptHeaderService)

Parameters:

workflow - the receipt workflow service

getIsSubmitAction

public Boolean getIsSubmitAction()

Returns:

true if the current action is submit_for_approval

getAllowPartialSelection

public Boolean getAllowPartialSelection()

Returns:

true if partial selection is to be allowed for submission/approval, else false

getIsApproveAction

public Boolean getIsApproveAction()

Returns:

true if the current action is approve

getIsRejectAction

public Boolean getIsRejectAction()

Returns:

true if the current action is approve

getModel

public Object getModel()

getCounterId

public Long getCounterId()

Returns:

the counter id

setCounterId

public void setCounterId(Long counterId)

Parameters:

counterId - the counter id to be set

getUserName

public String getUserName()

Returns:

the user name

setUserName

public void setUserName(String userName)

Parameters:

userName - the user name to set

getServiceCode

public String getServiceCode()

Returns:

the service code

setServiceCode

public void setServiceCode(String serviceCode)

Parameters:

serviceCode - the Service Code to set

getReceiptHeaders

public List<org.egov.collection.entity.ReceiptHeader> getReceiptHeaders()

Returns:

List for receipt headers in status "To be submitted"

getTotalAmount

public BigDecimal getTotalAmount()

Returns:

The total amount of all receipts eligible for the workflow action

getCashAmount

public BigDecimal getCashAmount()

Returns:

Total amount collected as cash amongst all receipts eligible for the workflow action

getChequeAmount

public BigDecimal getChequeAmount()

Returns:

Total amount collected as cheque amongst all receipts eligible for the workflow action

getDdAmount

public BigDecimal getDdAmount()

Returns:

Total amount collected as dd amongst all receipts eligible for the workflow action

getCardAmount

public BigDecimal getCardAmount()

Returns:

Total amount collected using card amongst all receipts eligible for the workflow action

getBankAmount

public BigDecimal getBankAmount()

Returns:

Total amount collected using bank amongst all receipts eligible for the workflow action

setReceiptIds

public void setReceiptIds(Long[] receiptIds)

Parameters:

Array - of receipt Ids

setRemarks

public void setRemarks(String remarks)

Parameters:

Submission - /Approval/Rejection remarks

listWorkflow

public String listWorkflow()

Action that will be called from the workflow inbox. The inbox also passes the id of the clicked item which is of the form: -servicecode-userid-counterid

Returns:

Next page to be displayed (index)

submissionReportCash

public String submissionReportCash()

Action for creating cash submission report

Returns:

submissionReport

submissionReportCheque

public String submissionReportCheque()

Action for creating cash submission report

Returns:

submissionReport

submitCollections

public String submitCollections()

Action method to submit the selected receipt headers

Returns:

SUCCESS/ERROR

submitAllCollections

public String submitAllCollections()

approveCollections

public String approveCollections()

Action method to approve the selected receipt headers

Returns:

SUCCESS/ERROR

approveAllCollections

public String approveAllCollections()

rejectCollections

public String rejectCollections()

Action method to reject the selected receipt headers

Returns:

SUCCESS/ERROR

getReceiptDate

public String getReceiptDate()

setReceiptDate

public void setReceiptDate(String receiptDate)

getApproverName

public String getApproverName()

setApproverName

public void setApproverName(String approverName)