org.egov.collection.integration.services

Class CollectionIntegrationServiceImpl

java.lang.Object

org.egov.infstr.services.PersistenceService<ReceiptHeader,Long>

org.egov.collection.integration.services.CollectionIntegrationServiceImpl

All Implemented Interfaces:

CollectionIntegrationService

@Transactional(readOnly=true)
public class CollectionIntegrationServiceImpl
extends org.egov.infstr.services.PersistenceService<ReceiptHeader,Long>
implements CollectionIntegrationService

Collections integration service implementation - exposes APIs that can be used by other applications (typically billing systems) to interact with the collections module.

Constructor Summary

Constructors

Constructor and Description
CollectionIntegrationServiceImpl()

Method Summary

Modifier and Type	Method and Description
String	cancelReceipt(PaymentInfoSearchRequest cancelReq) 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 aggrReq) 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 aggrReq) 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
void	setCollectionCommon(CollectionCommon collectionCommon)
void	setCollectionsUtil(CollectionsUtil collectionsUtil)
void	setPersistenceService(org.egov.infstr.services.PersistenceService persistenceService)
void	setReceiptHeaderService(ReceiptHeaderService receiptHeaderService)

Methods inherited from class org.egov.infstr.services.PersistenceService

addFilterCriteriaForObject, addIndexparams, applyAuditing, applyAuditing, create, delete, find, find, findAll, findAll, findAllBy, findAllByNamedQuery, findByExample, findById, findById, findByIdWithJoinFetch, findByNamedQuery, findPageBy, findPageByNamedQuery, getNamedQuery, getSearchSession, getSession, getType, indexEntity, load, merge, persist, search, search, update, validate, validateModel

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectionIntegrationServiceImpl

public CollectionIntegrationServiceImpl()

Method Detail

setReceiptHeaderService

public void setReceiptHeaderService(ReceiptHeaderService receiptHeaderService)

setCollectionsUtil

public void setCollectionsUtil(CollectionsUtil collectionsUtil)

getBillReceiptInfo

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

Description copied from interface: CollectionIntegrationService

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.

Specified by:

getBillReceiptInfo in interface CollectionIntegrationService

Parameters:

serviceCode - The service code of the billing system

refNum - The bill reference number

Returns:

The bill receipt information

getBillReceiptInfo

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

Description copied from interface: CollectionIntegrationService

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

Specified by:

getBillReceiptInfo in interface CollectionIntegrationService

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

getInstrumentReceiptInfo

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

Description copied from interface: CollectionIntegrationService

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.

Specified by:

getInstrumentReceiptInfo in interface CollectionIntegrationService

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

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

Description copied from interface: CollectionIntegrationService

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.

Specified by:

getInstrumentReceiptInfo in interface CollectionIntegrationService

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

getReceiptInfo

public BillReceiptInfo getReceiptInfo(String serviceCode,
                                      String receiptNum)

Description copied from interface: CollectionIntegrationService

Returns the bill receipt information for given receipt number

Specified by:

getReceiptInfo in interface CollectionIntegrationService

Parameters:

serviceCode - The service code of the billing system

receiptNum - The Collections or Manual Receipt Number

Returns:

The bill receipt information

getDetailsByTransactionId

public RestReceiptInfo getDetailsByTransactionId(PaymentInfoSearchRequest paymentInfoSearchRequest)

Description copied from interface: CollectionIntegrationService

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

Specified by:

getDetailsByTransactionId in interface CollectionIntegrationService

Returns:

RestReceiptInfo containing details of Receipt Information

getReceiptInfo

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

Description copied from interface: CollectionIntegrationService

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

Specified by:

getReceiptInfo in interface CollectionIntegrationService

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

createReceipt

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

Description copied from interface: CollectionIntegrationService

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

Specified by:

createReceipt in interface CollectionIntegrationService

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

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

Description copied from interface: CollectionIntegrationService

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

Specified by:

getOnlinePendingReceipts in interface CollectionIntegrationService

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

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

Description copied from interface: CollectionIntegrationService

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

Specified by:

createMiscellaneousReceipt in interface CollectionIntegrationService

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

public List<RestAggregatePaymentInfo> getAggregateReceiptTotal(PaymentInfoSearchRequest aggrReq)

Description copied from interface: CollectionIntegrationService

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

Specified by:

getAggregateReceiptTotal in interface CollectionIntegrationService

Returns:

List of RestAggregatePaymentInfo containing aggregate information of receipts

getReceiptDetailsByDateAndService

public List<RestReceiptInfo> getReceiptDetailsByDateAndService(PaymentInfoSearchRequest aggrReq)

Description copied from interface: CollectionIntegrationService

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

Specified by:

getReceiptDetailsByDateAndService in interface CollectionIntegrationService

Returns:

List of RestReceiptInfo containing details of Receipt Information

cancelReceipt

public String cancelReceipt(PaymentInfoSearchRequest cancelReq)

Description copied from interface: CollectionIntegrationService

This method cancel the receipt information provided by the billing system

Specified by:

cancelReceipt in interface CollectionIntegrationService

Returns:

success/failure based on the cancellation status

getReceiptDetailListByReceiptNumber

public List<ReceiptDetail> getReceiptDetailListByReceiptNumber(String receiptNumber)

Description copied from interface: CollectionIntegrationService

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

Specified by:

getReceiptDetailListByReceiptNumber in interface CollectionIntegrationService

Returns:

List of ReceiptDetail

processMobilePayments

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

Description copied from interface: CollectionIntegrationService

This method returns Payment Request to process payments through mobile

Specified by:

processMobilePayments in interface CollectionIntegrationService

Returns:

PaymentRequest

Throws:

org.egov.infra.validation.exception.ValidationException

setCollectionCommon

public void setCollectionCommon(CollectionCommon collectionCommon)

setPersistenceService

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