org.egov.collection.integration.services

Interface CollectionIntegrationService

All Known Implementing Classes:

CollectionIntegrationServiceImpl

public interface CollectionIntegrationService

Interface exposed by collections system to other systems (typically billing systems)

Method Summary

Modifier and Type	Method and Description
String	cancelReceipt(PaymentInfoSearchRequest paymentInfoSearchRequest) This method cancel the receipt information provided by the billing system
BillReceiptInfo	createMiscellaneousReceipt(BillInfo bill, List<PaymentInfo> paymentInfoList) This method creates the miscellaneous receipt for the given bill and payment information
BillReceiptInfo	createReceipt(BillInfo bill, List<PaymentInfo> paymentInfoList) This method creates the receipt for the given bill and payment information
List<RestAggregatePaymentInfo>	getAggregateReceiptTotal(PaymentInfoSearchRequest paymentInfoSearchRequest) This method returns the count of receipts created with the sum total of receipt amount for the given date range
Map<String,List<BillReceiptInfo>>	getBillReceiptInfo(String serviceCode, Set<String> refNums) Returns the bill receipt information for given set of reference numbers (typically bill numbers)
List<BillReceiptInfo>	getBillReceiptInfo(String serviceCode, String refNum) Returns the list of bill receipt information objects for given reference number (typically bill number).
RestReceiptInfo	getDetailsByTransactionId(PaymentInfoSearchRequest paymentInfoSearchRequest) This method returns the receipt information for the transaction id and channel information provided by the billing system.
Map<String,List<BillReceiptInfo>>	getInstrumentReceiptInfo(String serviceCode, Set<String> instrumentNums) Returns the bill receipt information for given set of instrument numbers.
List<BillReceiptInfo>	getInstrumentReceiptInfo(String serviceCode, String instrumentNum) Returns set of bill receipt information for given instrument number.
List<BillReceiptInfo>	getOnlinePendingReceipts(String serviceCode, String consumerCode) Returns the online pending bill receipt information for given service and consumer code
List<ReceiptDetail>	getReceiptDetailListByReceiptNumber(String receiptNumber) This method returns sorted list of only the paid receipt detail for the receipt number provided
List<RestReceiptInfo>	getReceiptDetailsByDateAndService(PaymentInfoSearchRequest paymentInfoSearchRequest) This method returns the list of receipt created in the system for the given date range and service code of the billing system.
Map<String,BillReceiptInfo>	getReceiptInfo(String serviceCode, Set<String> receiptNums) Returns HashMap of the bill receipt information for given set of receipt numbers
BillReceiptInfo	getReceiptInfo(String serviceCode, String receiptNum) Returns the bill receipt information for given receipt number
PaymentRequest	processMobilePayments(BillInfoImpl billInfo) This method returns Payment Request to process payments through mobile

Method Detail

getBillReceiptInfo

List<BillReceiptInfo> getBillReceiptInfo(String serviceCode,
                                         String refNum)

Returns the list of bill receipt information objects for given reference number (typically bill number). One bill can be associated with multiple receipts in case of part payments.

Parameters:

serviceCode - The service code of the billing system

refNum - The bill reference number

Returns:

The bill receipt information

getBillReceiptInfo

Map<String,List<BillReceiptInfo>> getBillReceiptInfo(String serviceCode,
                                                     Set<String> refNums)

Returns the bill receipt information for given set of reference numbers (typically bill numbers)

Parameters:

serviceCode - The service code of the billing system

refNums - Set of bill reference numbers

Returns:

Map of bill receipt information objects. Key = bill reference number, value = List of Bill receipt information objects

getReceiptInfo

BillReceiptInfo getReceiptInfo(String serviceCode,
                               String receiptNum)

Returns the bill receipt information for given receipt number

Parameters:

serviceCode - The service code of the billing system

receiptNum - The Collections or Manual Receipt Number

Returns:

The bill receipt information

getReceiptInfo

Map<String,BillReceiptInfo> getReceiptInfo(String serviceCode,
                                           Set<String> receiptNums)

Returns HashMap of the bill receipt information for given set of receipt numbers

Parameters:

serviceCode - The service code of the billing system

receiptNums - Set of Collections or Manual Receipt Number

Returns:

Map of bill receipt information objects. Key = bill reference number, value = Bill receipt information object

getInstrumentReceiptInfo

List<BillReceiptInfo> getInstrumentReceiptInfo(String serviceCode,
                                               String instrumentNum)

Returns set of bill receipt information for given instrument number. One instrument might have been used to pay for more than one bills, hence may belong to more than one receipts.

Parameters:

serviceCode - The service code of the billing system

instrumentNum - The instrument number

Returns:

The set of bill receipt information objects for given instrument number

getInstrumentReceiptInfo

Map<String,List<BillReceiptInfo>> getInstrumentReceiptInfo(String serviceCode,
                                                           Set<String> instrumentNums)

Returns the bill receipt information for given set of instrument numbers. Since one instrument may belong to more than one receipts, this method will return a map of instrument number to set of bill receipt information objects.

Parameters:

serviceCode - The service code of the billing system

instrumentNums - Set of instrument numbers

Returns:

Map of bill receipt information objects. Key = instrument number, value = Set of Bill receipt information objects

createReceipt

BillReceiptInfo createReceipt(BillInfo bill,
                              List<PaymentInfo> paymentInfoList)

This method creates the receipt for the given bill and payment information

Parameters:

bill - an instance of BillInfo containing the bill information.

paymentInfoList - a List of PaymentInfo containing the payment information. A List is used in order to accommodate payment using multiple cheques/DDs for a single receipt. In all other cases, it should be taken care that only a single mode of payment is permitted, i.e., the List should contain a single entry.

Returns:

an instance of BillReceiptInfo containing all details of the created receipt.

getOnlinePendingReceipts

List<BillReceiptInfo> getOnlinePendingReceipts(String serviceCode,
                                               String consumerCode)

Returns the online pending bill receipt information for given service and consumer code

Parameters:

serviceCode - The service code of the billing system

consumerCode - The consumer code of the billing system

Returns:

List of Pending Bill receipt information objects

createMiscellaneousReceipt

BillReceiptInfo createMiscellaneousReceipt(BillInfo bill,
                                           List<PaymentInfo> paymentInfoList)

This method creates the miscellaneous receipt for the given bill and payment information

Parameters:

bill - an instance of BillInfo containing the bill information.

paymentInfoList - a List of PaymentInfo containing the payment information. A List is used in order to accommodate payment using multiple cheques/DDs for a single receipt. In all other cases, it should be taken care that only a single mode of payment is permitted, i.e., the List should contain a single entry.

Returns:

an instance of BillReceiptInfo containing all details of the created receipt.

getAggregateReceiptTotal

List<RestAggregatePaymentInfo> getAggregateReceiptTotal(PaymentInfoSearchRequest paymentInfoSearchRequest)

This method returns the count of receipts created with the sum total of receipt amount for the given date range

Parameters:

fromDate - From Date to Search the Aggregate Payment

toDate - To Date to Search the Aggregate Payment

Returns:

List of RestAggregatePaymentInfo containing aggregate information of receipts

getReceiptDetailsByDateAndService

List<RestReceiptInfo> getReceiptDetailsByDateAndService(PaymentInfoSearchRequest paymentInfoSearchRequest)

This method returns the list of receipt created in the system for the given date range and service code of the billing system.

Parameters:

fromDate - From Date to Search the Aggregate Paymentss

toDate - To Date to Search the Aggregate Payment

serviceCode - The service code of the billing system

Returns:

List of RestReceiptInfo containing details of Receipt Information

cancelReceipt

String cancelReceipt(PaymentInfoSearchRequest paymentInfoSearchRequest)

This method cancel the receipt information provided by the billing system

Parameters:

paymentInfoSearchRequest -

Returns:

success/failure based on the cancellation status

getDetailsByTransactionId

RestReceiptInfo getDetailsByTransactionId(PaymentInfoSearchRequest paymentInfoSearchRequest)

This method returns the receipt information for the transaction id and channel information provided by the billing system.

Parameters:

paymentInfoSearchRequest -

Returns:

RestReceiptInfo containing details of Receipt Information

getReceiptDetailListByReceiptNumber

List<ReceiptDetail> getReceiptDetailListByReceiptNumber(String receiptNumber)

This method returns sorted list of only the paid receipt detail for the receipt number provided

Parameters:

receiptNumber -

Returns:

List of ReceiptDetail

processMobilePayments

PaymentRequest processMobilePayments(BillInfoImpl billInfo)
                              throws org.egov.infra.validation.exception.ValidationException

This method returns Payment Request to process payments through mobile

Parameters:

billInfo -

Returns:

PaymentRequest

Throws:

org.egov.infra.validation.exception.ValidationException