org.egov.demand.integration

Class TaxCollection

java.lang.Object

org.egov.demand.integration.TaxCollection

All Implemented Interfaces:

org.egov.collection.integration.services.BillingIntegrationService

public abstract class TaxCollection
extends Object
implements org.egov.collection.integration.services.BillingIntegrationService

This class is used to persist Bills with Collection Details(i.e received from ErpCollection) .This is used for the integration of Collections .

Author:

Sathish Reddy K

Field Summary

Fields inherited from interface org.egov.collection.integration.services.BillingIntegrationService

EVENT_INSTRUMENT_BOUNCED, EVENT_RECEIPT_CANCELLED, EVENT_RECEIPT_CREATED

Constructor Summary

Constructors

Constructor and Description
TaxCollection()

Method Summary

Modifier and Type	Method and Description
void	apportionCollection(String billRefNo, BigDecimal amtPaid, List<org.egov.collection.entity.ReceiptDetail> receiptDetails) Billing system will implement this method when the billing system send "<enablebillapportioning> as true to Collection System in the bill-xml.
void	apportionPaidAmount(String billReferenceNumber, BigDecimal actualAmountPaid, ArrayList<org.egov.collection.entity.ReceiptDetail> receiptDetails)
BigDecimal	calculateTotalCollectedAmt(org.egov.collection.integration.models.BillReceiptInfo bri, List<EgBillDetails> billDetList) Called to calculate the total Receipt Amount i,e the amount which has been paid for the Bill From the BillReceiptInfo the amount will be calculated.
protected List<org.egov.commons.Installment>	getAllInstallments() Gets a list of all installments for the billing system.
protected org.egov.commons.Installment	getCurrentInstallment() Finds the currently active installment.
protected EgDemandReason	getCurrentReason(String categoryCode, String reasonMasterCode) Finds the current reason for the given master and category.
EgDemandDetails	getDemandDetail(EgDemand egDemand, org.egov.commons.Installment instl, String code) Finds the demand-detail for the given installment and reason.
protected EgDemandReasonMaster	getDemandReasonMaster(String code) Finds the demand-reason-master having the given code.
BigDecimal	getEgBillDetailCollection(EgBillDetails billdet) Here we get the Bill DCB(Bill Amount - Collected amount).
protected org.egov.commons.Installment	getInstallmentForDate(Date date) For a given date, finds the installment that contains it.
BigDecimal	getTotalChequeAmt(org.egov.collection.integration.models.BillReceiptInfo bri) Here we get the total cheque Amount (i.e the Amount in which the cheque gets bounced.)
protected abstract org.egov.infra.admin.master.entity.Module	module() The module that defines the billing system.
protected EgdmCollectedReceipt	persistCollectedReceipts(EgDemandDetails egDemandDetails, String receiptNumber, BigDecimal receiptAmount, Date receiptDate, BigDecimal reasonAmount) Persists the Receipt Details with the EgDemandDetail id as the reference and the status as active.
EgBill	updateBillForChqBounce(org.egov.collection.integration.models.BillReceiptInfo bri, EgBill egBill, BigDecimal totalChqAmt) Method will be called when a Cheque is Bounced .Here the EGBill and EgBillDetails tables are updated with the cancelled Cheque amount.
abstract void	updateDemandDetails(org.egov.collection.integration.models.BillReceiptInfo bri) EgDemand and EgdemandDetails updation is a client specific ..
void	updateReceiptDetails(Set<org.egov.collection.integration.models.BillReceiptInfo> billReceipts) Called when there is a collection happened or a receipt cancelled or a cheque bounced.
protected void	updateReceiptStatusWhenCancelled(String receiptNumber) When receipt is cancelled the status of the receipt in EgdmCollectedReceipts is updated as Cancelled.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.egov.collection.integration.services.BillingIntegrationService

constructAdditionalInfoForReceipt, receiptAmountBifurcation, reconstructReceiptDetail

Constructor Detail

TaxCollection

public TaxCollection()

Method Detail

updateReceiptDetails

public void updateReceiptDetails(Set<org.egov.collection.integration.models.BillReceiptInfo> billReceipts)
                          throws org.egov.infra.exception.ApplicationRuntimeException

Called when there is a collection happened or a receipt cancelled or a cheque bounced.

Specified by:

updateReceiptDetails in interface org.egov.collection.integration.services.BillingIntegrationService

Parameters:

java - .util.Set billReceipts

Throws:

org.egov.infra.exception.ApplicationRuntimeException

updateBillForChqBounce

public EgBill updateBillForChqBounce(org.egov.collection.integration.models.BillReceiptInfo bri,
                                     EgBill egBill,
                                     BigDecimal totalChqAmt)

Method will be called when a Cheque is Bounced .Here the EGBill and EgBillDetails tables are updated with the cancelled Cheque amount.

Parameters:

org - .egov.infstr.collections.integration.models.BillReceiptInfo

org - .egov.demand.model.EgBill egBill

java - .math.BigDecimal totalCollAmt totalCollectedAmt

Returns:

org.egov.demand.model.EgBill egBill

calculateTotalCollectedAmt

public BigDecimal calculateTotalCollectedAmt(org.egov.collection.integration.models.BillReceiptInfo bri,
                                             List<EgBillDetails> billDetList)
                                      throws InvalidAccountHeadException

Called to calculate the total Receipt Amount i,e the amount which has been paid for the Bill From the BillReceiptInfo the amount will be calculated. If the Glcode which exists in EgBillDetails is not matching with the Glcode the ErpCollection send ,then an exception will be raised(InvalidAccountHeadException).

Parameters:

org - .egov.infstr.collections.integration.models.BillReceiptInfo

java - .util.List billDetList

Returns:

java.math.BigDecimal totalCollAmt

Throws:

InvalidAccountHeadException

getTotalChequeAmt

public BigDecimal getTotalChequeAmt(org.egov.collection.integration.models.BillReceiptInfo bri)

Here we get the total cheque Amount (i.e the Amount in which the cheque gets bounced.)

Parameters:

org - .egov.infstr.collections.integration.models.BillReceiptInfo

Returns:

java.math.BigDecimal balanceAmt

Throws:

org.egov.infra.exception.ApplicationRuntimeException

getEgBillDetailCollection

public BigDecimal getEgBillDetailCollection(EgBillDetails billdet)

Here we get the Bill DCB(Bill Amount - Collected amount).

Parameters:

org - .egov.demand.model.EgBillDetails billdet

Returns:

java.math.BigDecimal balanceAmt

updateDemandDetails

public abstract void updateDemandDetails(org.egov.collection.integration.models.BillReceiptInfo bri)

EgDemand and EgdemandDetails updation is a client specific .. So the Client which extends this abstract class needs to implement(override) this method. For Ex :- In PTIS Module: there will be only a base tax(basic Demand) in general, But in COCPTIS the base tax is divided into 4 individual taxes . If any info which is required is missed out then an exception needs to be raised with proper message

Parameters:

org - .egov.infstr.collections.integration.models.BillReceiptInfo

module

protected abstract org.egov.infra.admin.master.entity.Module module()

The module that defines the billing system.

Returns:

getInstallmentForDate

protected org.egov.commons.Installment getInstallmentForDate(Date date)

For a given date, finds the installment that contains it.

Parameters:

date -

Returns:

getCurrentInstallment

protected org.egov.commons.Installment getCurrentInstallment()

Finds the currently active installment.

Returns:

getAllInstallments

protected List<org.egov.commons.Installment> getAllInstallments()

Gets a list of all installments for the billing system.

Returns:

getDemandReasonMaster

protected EgDemandReasonMaster getDemandReasonMaster(String code)

Finds the demand-reason-master having the given code.

Parameters:

code -

Returns:

getDemandDetail

public EgDemandDetails getDemandDetail(EgDemand egDemand,
                                       org.egov.commons.Installment instl,
                                       String code)

Finds the demand-detail for the given installment and reason.

Parameters:

egDemand -

instl -

code -

Returns:

getCurrentReason

protected EgDemandReason getCurrentReason(String categoryCode,
                                          String reasonMasterCode)

Finds the current reason for the given master and category.

Parameters:

categoryCode -

reasonMasterCode -

Returns:

persistCollectedReceipts

protected EgdmCollectedReceipt persistCollectedReceipts(EgDemandDetails egDemandDetails,
                                                        String receiptNumber,
                                                        BigDecimal receiptAmount,
                                                        Date receiptDate,
                                                        BigDecimal reasonAmount)

Persists the Receipt Details with the EgDemandDetail id as the reference and the status as active.

Parameters:

egDemandDetails -

billRcptInfo -

Returns:

egDmCollectedReceipt

updateReceiptStatusWhenCancelled

protected void updateReceiptStatusWhenCancelled(String receiptNumber)

When receipt is cancelled the status of the receipt in EgdmCollectedReceipts is updated as Cancelled.

Parameters:

egDmCollectedReceipt -

apportionPaidAmount

public void apportionPaidAmount(String billReferenceNumber,
                                BigDecimal actualAmountPaid,
                                ArrayList<org.egov.collection.entity.ReceiptDetail> receiptDetails)

Specified by:

apportionPaidAmount in interface org.egov.collection.integration.services.BillingIntegrationService

apportionCollection

public void apportionCollection(String billRefNo,
                                BigDecimal amtPaid,
                                List<org.egov.collection.entity.ReceiptDetail> receiptDetails)

Billing system will implement this method when the billing system send "<enablebillapportioning> as true to Collection System in the bill-xml.

Parameters:

billRefNo - Bill Reference Number of the bill send by billing system

amtPaid - Acutal amount paid at the counter

receiptDetails - List of ReceiptDetails object associated with this bill