org.egov.collection.integration.services

Class BillingIntegrationServiceStub

java.lang.Object

org.egov.collection.integration.services.BillingIntegrationServiceStub

All Implemented Interfaces:

BillingIntegrationService

public class BillingIntegrationServiceStub
extends Object
implements BillingIntegrationService

This interface needs to be implemented by any billing application that integrates with the eGov collection system. For internal applications, the methods can use direct API calls. For external applications, the integration can be through web-service/REST calls. The convention to be followed: a bean named "collectionsInterface" needs to be available in the spring context. Service name is the name provided for the billing service in class.

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
BillingIntegrationServiceStub()

Method Summary

Modifier and Type	Method and Description
void	apportionPaidAmount(String billReferenceNumber, BigDecimal actualAmountPaid, ArrayList<ReceiptDetail> receiptDetailsArray) Collection system will invoke this method when the billing system send "<enablebillapportioning> as true in the bill-xml.
String	constructAdditionalInfoForReceipt(BillReceiptInfo billReceiptInfo) Collection system will invoke billing system to frame up the additional message to be printed in receipt
ReceiptAmountInfo	receiptAmountBifurcation(BillReceiptInfo billReceiptInfo) Collection system invokes billing system to get the amount bifurcation information from object passed as parameter.
List<ReceiptDetail>	reconstructReceiptDetail(String billReferenceNumber, BigDecimal actualAmountPaid, List<ReceiptDetail> receiptDetailList) Collection system will invoke this method only when this receipt status is PENDING and there is one more receipt in system created on later/same day with status as APPROVED/SUBMITTED/TO_BE_SUBMITTED
void	updateReceiptDetails(Set<BillReceiptInfo> billReceipts) This method needs to be implemented in order to update the billing system with the bill receipt information

Methods inherited from class java.lang.Object

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

Constructor Detail

BillingIntegrationServiceStub

public BillingIntegrationServiceStub()

Method Detail

updateReceiptDetails

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

Description copied from interface: BillingIntegrationService

This method needs to be implemented in order to update the billing system with the bill receipt information

Specified by:

updateReceiptDetails in interface BillingIntegrationService

Parameters:

billReceipts - a Set of BillReceiptInfo containing the bill receipt, receipt account and receipt instrument information. The information also includes the event for which the billing system needs to be updated.

Throws:

org.egov.infra.exception.ApplicationRuntimeException

apportionPaidAmount

public void apportionPaidAmount(String billReferenceNumber,
                                BigDecimal actualAmountPaid,
                                ArrayList<ReceiptDetail> receiptDetailsArray)

Description copied from interface: BillingIntegrationService

Collection system will invoke this method when the billing system send "<enablebillapportioning> as true in the bill-xml. In case of any exception occurred while apportioning, billing system will throw ValidationException.

Specified by:

apportionPaidAmount in interface BillingIntegrationService

Parameters:

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

actualAmountPaid - Acutal amount paid at the counter

receiptDetailsArray - List of ReceiptDetails object associated with this bill

reconstructReceiptDetail

public List<ReceiptDetail> reconstructReceiptDetail(String billReferenceNumber,
                                                    BigDecimal actualAmountPaid,
                                                    List<ReceiptDetail> receiptDetailList)

Description copied from interface: BillingIntegrationService

Collection system will invoke this method only when this receipt status is PENDING and there is one more receipt in system created on later/same day with status as APPROVED/SUBMITTED/TO_BE_SUBMITTED

Specified by:

reconstructReceiptDetail in interface BillingIntegrationService

Parameters:

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

actualAmountPaid - Actual amount paid by the citizen

receiptDetailList - List of existing receipt details

Returns:

Reconstructed List of ReceiptDetail objects

constructAdditionalInfoForReceipt

public String constructAdditionalInfoForReceipt(BillReceiptInfo billReceiptInfo)

Description copied from interface: BillingIntegrationService

Collection system will invoke billing system to frame up the additional message to be printed in receipt

Specified by:

constructAdditionalInfoForReceipt in interface BillingIntegrationService

Returns:

Message to be printed in receipt

receiptAmountBifurcation

public ReceiptAmountInfo receiptAmountBifurcation(BillReceiptInfo billReceiptInfo)

Description copied from interface: BillingIntegrationService

Collection system invokes billing system to get the amount bifurcation information from object passed as parameter.

Specified by:

receiptAmountBifurcation in interface BillingIntegrationService

Returns: