org.egov.collection.utils

Class CollectionCommon

java.lang.Object

org.egov.collection.utils.CollectionCommon

@Transactional(readOnly=true)
public class CollectionCommon
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected org.egov.infstr.services.PersistenceService	persistenceService

Constructor Summary

Constructors

Constructor and Description
CollectionCommon()

Method Summary

Modifier and Type	Method and Description
ReceiptDetail	addDebitAccountHeadDetails(BigDecimal debitAmount, ReceiptHeader receiptHeader, BigDecimal chequeInstrumenttotal, BigDecimal otherInstrumenttotal, String instrumentType)
List<ReceiptDetail>	apportionBillAmount(BigDecimal actualAmountPaid, ArrayList<ReceiptDetail> receiptDetails)
void	cancelChallanReceipt(ReceiptHeader receiptHeader, boolean cancelInstrument) This method cancels the given receipt.
void	cancelChallanReceiptOnCreation(ReceiptHeader receiptHeader) This method cancels the receipt against a challan.
PaymentRequest	createPaymentRequest(org.egov.infstr.models.ServiceDetails paymentServiceDetails, ReceiptHeader receiptHeader)
PaymentResponse	createPaymentResponse(org.egov.infstr.models.ServiceDetails paymentServiceDetails, String response) This method returns the payment response object for the given response string.
ReceiptHeader	createPendingReceiptFromCancelledChallanReceipt(ReceiptHeader oldReceiptHeader) This method create a new receipt header object with details contained in given receipt header object.
String	generateChallan(ReceiptHeader receipt, boolean flag) This method generates a challan for the given receipt
String	generateReport(ReceiptHeader[] receipts, boolean flag) This method generates a report for the given array of receipts
String	getFinancialYearIdByDate(Date date) This method is used to get the financial Year Id for the given date
protected PaymentGatewayAdaptor	getPaymentGatewayAdaptor(String serviceCode)
ReceiptHeader	initialiseReceiptModelWithBillInfo(BillInfo collDetails, org.egov.commons.Fund fund, org.egov.infra.admin.master.entity.Department dept) This method initialises the model, a list of ReceiptPayeeDetails objects with the information contained in the unmarshalled BillCollection instance.
List<ReceiptDetailInfo>	setAccountPayeeList(ReceiptHeader rh)
void	setCollectionsUtil(CollectionsUtil collectionsUtil)
void	setEgovCommon(org.egov.egf.commons.EgovCommon egovCommon)
void	setFinancialsUtil(FinancialsUtil financialsUtil)
void	setPersistenceService(org.egov.infstr.services.PersistenceService persistenceService)
List<ReceiptDetailInfo>	setReceiptDetailsList(ReceiptHeader rh, String amountType)
void	setReceiptHeaderService(ReceiptHeaderService receiptHeaderService)
org.egov.model.instrument.InstrumentHeader	validateAndConstructBankInstrument(PaymentInfoBank paytInfoBank) Checks if the bank instrument number, transaction number, transaction date, bank branch, bank account number are valid
org.egov.model.instrument.InstrumentHeader	validateAndConstructCashInstrument(PaymentInfoCash paytInfoCash)
org.egov.model.instrument.InstrumentHeader	validateAndConstructChequeDDInstrument(PaymentInfoChequeDD paytInfoChequeDD) Checks if the cheque/DD instrument number, instrument date, are valid.

Methods inherited from class java.lang.Object

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

Field Detail

persistenceService

protected org.egov.infstr.services.PersistenceService persistenceService

Constructor Detail

CollectionCommon

public CollectionCommon()

Method Detail

setReceiptHeaderService

public void setReceiptHeaderService(ReceiptHeaderService receiptHeaderService)

Parameters:

receiptHeaderService - the receipt header Service to be set

setPersistenceService

public void setPersistenceService(org.egov.infstr.services.PersistenceService persistenceService)

Parameters:

persistenceService - the persistenceService to set

setCollectionsUtil

public void setCollectionsUtil(CollectionsUtil collectionsUtil)

Parameters:

collectionsUtil - the collectionsUtil to set

setFinancialsUtil

public void setFinancialsUtil(FinancialsUtil financialsUtil)

Parameters:

FinancialsUtil - the FinancialsUtil to set

addDebitAccountHeadDetails

public ReceiptDetail addDebitAccountHeadDetails(BigDecimal debitAmount,
                                                ReceiptHeader receiptHeader,
                                                BigDecimal chequeInstrumenttotal,
                                                BigDecimal otherInstrumenttotal,
                                                String instrumentType)

initialiseReceiptModelWithBillInfo

public ReceiptHeader initialiseReceiptModelWithBillInfo(BillInfo collDetails,
                                                        org.egov.commons.Fund fund,
                                                        org.egov.infra.admin.master.entity.Department dept)
                                                 throws org.egov.infra.validation.exception.ValidationException

This method initialises the model, a list of ReceiptPayeeDetails objects with the information contained in the unmarshalled BillCollection instance.

Throws:

org.egov.infra.validation.exception.ValidationException

createPaymentResponse

public PaymentResponse createPaymentResponse(org.egov.infstr.models.ServiceDetails paymentServiceDetails,
                                             String response)

This method returns the payment response object for the given response string.

Parameters:

paymentServiceDetails -

response -

Returns:

generateReport

public String generateReport(ReceiptHeader[] receipts,
                             boolean flag)

This method generates a report for the given array of receipts

Parameters:

receipts - an array of ReceiptHeader objects for which the report is to be generated

flag - a boolean value indicating if the generated report should also have the print option

Returns:

an integer representing the report id

generateChallan

public String generateChallan(ReceiptHeader receipt,
                              boolean flag)

This method generates a challan for the given receipt

Parameters:

receipt - ReceiptHeader object for which the report is to be generated

flag - a boolean value indicating if the generated challan should also have the print option

Returns:

an integer representing the report id

createPaymentRequest

public PaymentRequest createPaymentRequest(org.egov.infstr.models.ServiceDetails paymentServiceDetails,
                                           ReceiptHeader receiptHeader)

getPaymentGatewayAdaptor

protected PaymentGatewayAdaptor getPaymentGatewayAdaptor(String serviceCode)

setEgovCommon

public void setEgovCommon(org.egov.egf.commons.EgovCommon egovCommon)

Parameters:

egovCommon - the egovCommon to set

setReceiptDetailsList

public List<ReceiptDetailInfo> setReceiptDetailsList(ReceiptHeader rh,
                                                     String amountType)

setAccountPayeeList

public List<ReceiptDetailInfo> setAccountPayeeList(ReceiptHeader rh)

cancelChallanReceiptOnCreation

public void cancelChallanReceiptOnCreation(ReceiptHeader receiptHeader)

This method cancels the receipt against a challan. The reason for cancellation is set and the staus is changed to CANCELLED.

Parameters:

receiptHeader - the ReceiptHeader which contains a reference to the receipt to be cancelled.

createPendingReceiptFromCancelledChallanReceipt

public ReceiptHeader createPendingReceiptFromCancelledChallanReceipt(ReceiptHeader oldReceiptHeader)

This method create a new receipt header object with details contained in given receipt header object. Both the receipt header objects are added to the same parent ReceiptPayeeDetail object .

Parameters:

oldReceiptHeader - the instance of ReceiptHeader whose data is to be copied

cancelChallanReceipt

@Transactional
public void cancelChallanReceipt(ReceiptHeader receiptHeader,
                                                boolean cancelInstrument)

This method cancels the given receipt. The voucher for the instrument is reversed. The instrument may be cancelled based on the input parameter. (For post remittance cancellation of a receipt for a challan which has become invalid, the instrument should not be cancelled)

Parameters:

receiptHeader - the ReceiptHeader instance which has to be cancelled

cancelInstrument - a boolean value indicating if the instrument should be cancelled

getFinancialYearIdByDate

public String getFinancialYearIdByDate(Date date)

This method is used to get the financial Year Id for the given date

Returns:

the financial year id if exists else 0

validateAndConstructCashInstrument

public org.egov.model.instrument.InstrumentHeader validateAndConstructCashInstrument(PaymentInfoCash paytInfoCash)

validateAndConstructBankInstrument

public org.egov.model.instrument.InstrumentHeader validateAndConstructBankInstrument(PaymentInfoBank paytInfoBank)

Checks if the bank instrument number, transaction number, transaction date, bank branch, bank account number are valid

Parameters:

paytInfoBank -

Returns:

validateAndConstructChequeDDInstrument

public org.egov.model.instrument.InstrumentHeader validateAndConstructChequeDDInstrument(PaymentInfoChequeDD paytInfoChequeDD)

Checks if the cheque/DD instrument number, instrument date, are valid. An exception is thrown if the payment details are invalid, else an InstrumentHeader object is created from the payment details, and returned.

Parameters:

paytInfoBank -

Returns:

apportionBillAmount

public List<ReceiptDetail> apportionBillAmount(BigDecimal actualAmountPaid,
                                               ArrayList<ReceiptDetail> receiptDetails)