org.egov.collection.integration.services

Interface BillingIntegrationService

All Known Implementing Classes:

BillingIntegrationServiceStub

public interface 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 "<servicename>CollectionsInterface" needs to be available in the application context. Service name is the 'code' provided for the billing service in ServiceDetails class.

The method updateReceiptDetails will be called by collections system whenever an event occurs that needs to be communicated to the billing system e.g. receipt creation, receipt cancellation or instrument (related to a receipt) bounced.

The BillReceiptInfo object, apart from the receipt information, also provides this event code.

Field Summary

Fields

Modifier and Type	Field and Description
static String	EVENT_INSTRUMENT_BOUNCED A String indicating the event when the instrument for this receipt has bounced
static String	EVENT_RECEIPT_CANCELLED A String indicating the event that the receipt has been cancelled at the Collections end
static String	EVENT_RECEIPT_CREATED A String indicating the event that the receipt has been created at the Collections end

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

Field Detail

EVENT_INSTRUMENT_BOUNCED

static final String EVENT_INSTRUMENT_BOUNCED

A String indicating the event when the instrument for this receipt has bounced

See Also:

Constant Field Values

EVENT_RECEIPT_CREATED

static final String EVENT_RECEIPT_CREATED

A String indicating the event that the receipt has been created at the Collections end

See Also:

Constant Field Values

EVENT_RECEIPT_CANCELLED

static final String EVENT_RECEIPT_CANCELLED

A String indicating the event that the receipt has been cancelled at the Collections end

See Also:

Constant Field Values

Method Detail

updateReceiptDetails

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

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

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

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. In case of any exception occurred while apportioning, billing system will throw ValidationException.

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

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

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

String constructAdditionalInfoForReceipt(BillReceiptInfo billReceiptInfo)

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

Parameters:

billReceiptInfo -

Returns:

Message to be printed in receipt

receiptAmountBifurcation

ReceiptAmountInfo receiptAmountBifurcation(BillReceiptInfo billReceiptInfo)

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

Parameters:

billReceiptInfo -

Returns: