org.egov.collection.service

Class ReceiptHeaderService

java.lang.Object

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

org.egov.collection.service.ReceiptHeaderService

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

Provides services related to receipt header

Constructor Summary

Constructors

Constructor and Description
ReceiptHeaderService()
ReceiptHeaderService(Class<ReceiptHeader> type)

Method Summary

Modifier and Type	Method and Description
Set<ReceiptDetail>	aggregateDuplicateReceiptDetailObject(List<ReceiptDetail> receiptDetailSetParam) For Bill Based Receipt, aggregate the amount for same account heads
int	checkIfMapObjectExist(List<HashMap<String,Object>> paramList, Object[] arrayObjectInitialIndexTemp) Method to check if the given HashMap already exists in the List of HashMap
int	checkIfReceiptDetailObjectExist(List<ReceiptDetail> newReceiptDetailSet, ReceiptDetail receiptDetailObj) API to check if the given receipt detail object already exists in the list passed passed as parameter
List<org.egov.model.instrument.InstrumentHeader>	createInstrument(List<org.egov.model.instrument.InstrumentHeader> instrumentHeaderList)
Set<org.egov.model.instrument.InstrumentHeader>	createOnlineInstrument(Date transactionDate, String transactionId, BigDecimal transactionAmt)
ReceiptHeader	createOnlineSuccessPayment(ReceiptHeader receiptHeader, Date transactionDate, String transactionId, BigDecimal transactionAmt, String authStatusCode, String remarks, BillingIntegrationService billingService)
void	createReversalVoucher(ReceiptVoucher receiptVoucher) This method is called for voucher reversal in case of intra-day receipt cancellation.
protected org.egov.commons.CVoucherHeader	createVoucher(ReceiptHeader receiptHeader) This method is called for voucher creation into the financial system.
org.egov.commons.CVoucherHeader	createVoucherForReceipt(ReceiptHeader receiptHeader) Creates voucher for given receipt header and maps it with the same.
void	endReceiptWorkFlowOnCancellation(ReceiptHeader receiptHeaderToBeCancelled) End Work-flow of the given cancelled receipt
List<ReceiptHeader>	findAllByPositionAndInboxItemDetails(List<Long> positionIds, String groupingCriteria)
String	getAdditionalInfoForReceipt(String serviceCode, BillReceiptInfo billReceipt)
org.egov.pims.commons.Position	getApproverPosition(ReceiptHeader receiptHeader)
Date	getDataEntryCutOffDate(SimpleDateFormat sdf)
org.egov.pims.commons.Position	getOperatorPosition(ReceiptHeader receiptHeader)
String	getReceiptHeaderforDishonor(Long mode, Long bankAccId, Long bankId, String chequeDDNo, String chqueDDDate)
org.egov.infra.reporting.engine.ReportRequest	getReportRequest(ReceiptHeader receiptHeader)
void	perform(ReceiptHeader receiptHeader, String wfState, String newStatusCode, String nextAction, org.egov.pims.commons.Position ownerPosition, String remarks)
void	performWorkflow(String actionName, ReceiptHeader receiptHeader, String remarks)
void	performWorkflowForAllReceipts(String actionName, List<ReceiptHeader> receiptHeaders, String remarks)
ReceiptHeader	persist(ReceiptHeader receiptHeader) This method persists the given ReceiptPayeeDetails entity.
ReceiptHeader	persistChallan(ReceiptHeader receiptHeader, org.egov.pims.commons.Position position, String actionName, String approvalRemarks) This method persists the given ReceiptPayeeDetails entity.
void	persistFieldReceipt(ReceiptHeader receiptHeader, List<org.egov.model.instrument.InstrumentHeader> instrumentHeaderList)
ReceiptHeader	persistReceiptObject(ReceiptHeader receiptHeader) This method persists the given set of ReceiptPayeeDetails instances with receipt number as Pending
void	populateAndPersistReceipts(ReceiptHeader receiptHeader, List<org.egov.model.instrument.InstrumentHeader> receiptInstrList) This method performs the following for receipts to be newly created: The user instrument header details, and actual amount paid by user is captured. A debit receipt detail account head is created for the total credit collected. Vouchers are created
ReceiptHeader	reconcileOnlineSuccessPayment(ReceiptHeader onlinePaymentReceiptHeader, Date txnDate, String txnRefNo, BigDecimal txnAmount, String txnAuthStatus, List<ReceiptDetail> reconstructedList, ReceiptDetail debitAccountDetail)
void	setChallanService(ChallanService challanService)
void	setCollectionsNumberGenerator(CollectionsNumberGenerator collectionsNumberGenerator)
void	setCollectionsUtil(CollectionsUtil collectionsUtil)
void	setFinancialsUtil(FinancialsUtil financialsUtil)
void	setPersistenceService(org.egov.infstr.services.PersistenceService persistenceService)
void	setReceiptNumber(ReceiptHeader entity)
void	startWorkflow(ReceiptHeader receiptHeader) Starts workflow for given set of receipt headers.
Boolean	updateBillingSystem(org.egov.infstr.models.ServiceDetails serviceDetails, Set<BillReceiptInfo> billReceipts, BillingIntegrationService billingService) This method looks up the bean to communicate with the billing system and updates the billing system.
void	updateBillingSystemWithReceiptInfo(ReceiptHeader receiptHeader, BillingIntegrationService billingService, org.egov.model.instrument.InstrumentHeader bouncedInstrumentInfo) Updates the billing system with receipt information
void	updateCashRemittance(Map<String,Object> instrumentDepositeMap, String voucherWorkflowMsg, Date voucherDate, org.egov.commons.Bankaccount depositedBankAccount, String serviceGlCode, List<org.egov.model.instrument.InstrumentHeader> instrumentHeaderListCash, org.egov.commons.CVoucherHeader voucherHeaderCash)
void	updateChequeCardRemittance(Map<String,Object> instrumentDepositeMap, String voucherWorkflowMsg, Boolean voucherTypeForChequeDDCard, Date voucherDate, org.egov.commons.Bankaccount depositedBankAccount, String serviceGlCode, List<org.egov.model.instrument.InstrumentHeader> instrumentHeaderListCheque, org.egov.commons.CVoucherHeader voucherHeaderCheque)
void	updateCollectionIndexAndPushMail(ReceiptHeader receiptHeader)
void	updateDishonoredInstrumentStatus(ReceiptHeader receiptHeader, org.egov.model.instrument.InstrumentHeader bounceInstrumentInfo, org.egov.commons.EgwStatus receiptStatus, boolean isReconciled)
ReceiptHeader	updateFinancialAndBillingSystem(ReceiptHeader receiptHeader, BillingIntegrationService billingService)
void	updateInstrument(ReceiptHeader receiptHeader)
void	updateReceiptHeaderStatus(ReceiptHeader receiptHeader, org.egov.commons.EgwStatus status, boolean isReconciled) This method updates the status and reconciliation flag for the given receipt

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, getSession, getType, load, merge, update, validate, validateModel

Methods inherited from class java.lang.Object

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

Constructor Detail

ReceiptHeaderService

public ReceiptHeaderService()

ReceiptHeaderService

public ReceiptHeaderService(Class<ReceiptHeader> type)

Method Detail

findAllByPositionAndInboxItemDetails

public List<ReceiptHeader> findAllByPositionAndInboxItemDetails(List<Long> positionIds,
                                                                String groupingCriteria)

Parameters:

statusCode - Status code of receipts to be fetched. If null or ALL, then receipts with all statuses are fetched

userName - User name of the user who has created the receipts. If null or ALL, then receipts of all users are fetched

counterId - Counter id on which the receipts were created. If negative, then receipts from all counters are fetched

serviceCode - Service code for which the receipts were created. If null or ALL, then receipts of all billing services are fetched

Returns:

List of all receipts created by given user from given counter id and having given status

createVoucher

protected org.egov.commons.CVoucherHeader createVoucher(ReceiptHeader receiptHeader)

This method is called for voucher creation into the financial system. For each receipt created in the collections module, a voucher is created.

Parameters:

receiptHeader - Receipt header for which the pre-approval voucher is to be created

receiptBulkUpload -

Returns:

The created voucher

createVoucherForReceipt

public org.egov.commons.CVoucherHeader createVoucherForReceipt(ReceiptHeader receiptHeader)

Creates voucher for given receipt header and maps it with the same. Also updates the instrument voucher mapping in financials.

Parameters:

receiptHeader - Receipt header for which voucher is to be created

Returns:

The created voucher header

startWorkflow

public void startWorkflow(ReceiptHeader receiptHeader)

Starts workflow for given set of receipt headers. Internally performs the following: 1. Start workflow 2. Transition workflow state with action "Create Receipt" 3. Create vouchers (if required) 4. If vouchers created, transition workflow state with action "Create Voucher"

Parameters:

receiptHeaders - set of receipt headers on which workflow is to be started

receiptBulkUpload -

checkIfMapObjectExist

public int checkIfMapObjectExist(List<HashMap<String,Object>> paramList,
                                 Object[] arrayObjectInitialIndexTemp)

Method to check if the given HashMap already exists in the List of HashMap

Parameters:

queryResults -

objHashMap -

m -

Returns:

index of objHashMap in the queryResults

updateChequeCardRemittance

@Transactional
public void updateChequeCardRemittance(Map<String,Object> instrumentDepositeMap,
                                                      String voucherWorkflowMsg,
                                                      Boolean voucherTypeForChequeDDCard,
                                                      Date voucherDate,
                                                      org.egov.commons.Bankaccount depositedBankAccount,
                                                      String serviceGlCode,
                                                      List<org.egov.model.instrument.InstrumentHeader> instrumentHeaderListCheque,
                                                      org.egov.commons.CVoucherHeader voucherHeaderCheque)

updateCashRemittance

@Transactional
public void updateCashRemittance(Map<String,Object> instrumentDepositeMap,
                                                String voucherWorkflowMsg,
                                                Date voucherDate,
                                                org.egov.commons.Bankaccount depositedBankAccount,
                                                String serviceGlCode,
                                                List<org.egov.model.instrument.InstrumentHeader> instrumentHeaderListCash,
                                                org.egov.commons.CVoucherHeader voucherHeaderCash)

aggregateDuplicateReceiptDetailObject

public Set<ReceiptDetail> aggregateDuplicateReceiptDetailObject(List<ReceiptDetail> receiptDetailSetParam)

For Bill Based Receipt, aggregate the amount for same account heads

Parameters:

receiptDetailSetParam -

Returns:

Set of Receipt Detail after Aggregating Amounts

checkIfReceiptDetailObjectExist

public int checkIfReceiptDetailObjectExist(List<ReceiptDetail> newReceiptDetailSet,
                                           ReceiptDetail receiptDetailObj)

API to check if the given receipt detail object already exists in the list passed passed as parameter

Parameters:

newReceiptDetailSet -

receiptDetailObj -

Returns:

endReceiptWorkFlowOnCancellation

public void endReceiptWorkFlowOnCancellation(ReceiptHeader receiptHeaderToBeCancelled)

End Work-flow of the given cancelled receipt

Parameters:

receiptHeaders - Set of receipt headers to be transitioned

actionName - Action name for the transition

comment - Comment for the transition

persist

@Transactional
public ReceiptHeader persist(ReceiptHeader receiptHeader)
                                     throws org.egov.infra.exception.ApplicationRuntimeException

This method persists the given ReceiptPayeeDetails entity. The receipt number for all of the receipts is generated, if not already present. If the receipt is associated with a challan, and the challan number is not present, the challan number is generated and set into it.

Overrides:

persist in class org.egov.infstr.services.PersistenceService<ReceiptHeader,Long>

Throws:

org.egov.infra.exception.ApplicationRuntimeException

persistChallan

@Transactional
public ReceiptHeader persistChallan(ReceiptHeader receiptHeader,
                                                   org.egov.pims.commons.Position position,
                                                   String actionName,
                                                   String approvalRemarks)

This method persists the given ReceiptPayeeDetails entity. If the receipt number for all of the receipts is generated, if not already present.

persistReceiptObject

@Transactional
public ReceiptHeader persistReceiptObject(ReceiptHeader receiptHeader)

This method persists the given set of ReceiptPayeeDetails instances with receipt number as Pending

Parameters:

entity - a set of ReceiptPayeeDetails instances to be persisted

Returns:

the list of persisted ReceiptPayeeDetails instances

setReceiptNumber

public void setReceiptNumber(ReceiptHeader entity)

setCollectionsNumberGenerator

public void setCollectionsNumberGenerator(CollectionsNumberGenerator collectionsNumberGenerator)

updateBillingSystem

@Transactional
public Boolean updateBillingSystem(org.egov.infstr.models.ServiceDetails serviceDetails,
                                                  Set<BillReceiptInfo> billReceipts,
                                                  BillingIntegrationService billingService)

This method looks up the bean to communicate with the billing system and updates the billing system.

getAdditionalInfoForReceipt

public String getAdditionalInfoForReceipt(String serviceCode,
                                          BillReceiptInfo billReceipt)

createReversalVoucher

public void createReversalVoucher(ReceiptVoucher receiptVoucher)

This method is called for voucher reversal in case of intra-day receipt cancellation.

updateInstrument

public void updateInstrument(ReceiptHeader receiptHeader)

Parameters:

receiptPayeeDetails -

createInstrument

public List<org.egov.model.instrument.InstrumentHeader> createInstrument(List<org.egov.model.instrument.InstrumentHeader> instrumentHeaderList)

performWorkflow

@Transactional
public void performWorkflow(String actionName,
                                           ReceiptHeader receiptHeader,
                                           String remarks)

performWorkflowForAllReceipts

@Transactional
public void performWorkflowForAllReceipts(String actionName,
                                                         List<ReceiptHeader> receiptHeaders,
                                                         String remarks)

getApproverPosition

public org.egov.pims.commons.Position getApproverPosition(ReceiptHeader receiptHeader)

getOperatorPosition

public org.egov.pims.commons.Position getOperatorPosition(ReceiptHeader receiptHeader)

perform

@Transactional
public void perform(ReceiptHeader receiptHeader,
                                   String wfState,
                                   String newStatusCode,
                                   String nextAction,
                                   org.egov.pims.commons.Position ownerPosition,
                                   String remarks)

createOnlineInstrument

public Set<org.egov.model.instrument.InstrumentHeader> createOnlineInstrument(Date transactionDate,
                                                                              String transactionId,
                                                                              BigDecimal transactionAmt)

getReceiptHeaderforDishonor

public String getReceiptHeaderforDishonor(Long mode,
                                          Long bankAccId,
                                          Long bankId,
                                          String chequeDDNo,
                                          String chqueDDDate)

populateAndPersistReceipts

@Transactional
public void populateAndPersistReceipts(ReceiptHeader receiptHeader,
                                                      List<org.egov.model.instrument.InstrumentHeader> receiptInstrList)

This method performs the following for receipts to be newly created:

1. The user instrument header details, and actual amount paid by user is captured.
2. A debit receipt detail account head is created for the total credit collected.
3. Vouchers are created

The receipts are persisted and work flow is started for these persisted receipts where in the receipt state is set to NEW The billing system is updated about the persisted receipts. These include details of both newly created as well as cancelled receipts. If the instrument list and voucher list are not empty, the .... is updated The receipt ids of the newly created receipts are collectively populated to be shown on the print screen

getDataEntryCutOffDate

public Date getDataEntryCutOffDate(SimpleDateFormat sdf)

updateBillingSystemWithReceiptInfo

@Transactional
public void updateBillingSystemWithReceiptInfo(ReceiptHeader receiptHeader,
                                                              BillingIntegrationService billingService,
                                                              org.egov.model.instrument.InstrumentHeader bouncedInstrumentInfo)

Updates the billing system with receipt information

Parameters:

receiptHeader -

updateCollectionIndexAndPushMail

@Transactional
public void updateCollectionIndexAndPushMail(ReceiptHeader receiptHeader)

getReportRequest

public org.egov.infra.reporting.engine.ReportRequest getReportRequest(ReceiptHeader receiptHeader)

createOnlineSuccessPayment

@Transactional
public ReceiptHeader createOnlineSuccessPayment(ReceiptHeader receiptHeader,
                                                               Date transactionDate,
                                                               String transactionId,
                                                               BigDecimal transactionAmt,
                                                               String authStatusCode,
                                                               String remarks,
                                                               BillingIntegrationService billingService)

Parameters:

receipts - - list of receipts which have to be processed as successful payments. For payments created as a response from bill desk, size of the array will be 1.

updateFinancialAndBillingSystem

@Transactional
public ReceiptHeader updateFinancialAndBillingSystem(ReceiptHeader receiptHeader,
                                                                    BillingIntegrationService billingService)

persistFieldReceipt

@Transactional
public void persistFieldReceipt(ReceiptHeader receiptHeader,
                                               List<org.egov.model.instrument.InstrumentHeader> instrumentHeaderList)

updateDishonoredInstrumentStatus

@Transactional
public void updateDishonoredInstrumentStatus(ReceiptHeader receiptHeader,
                                                            org.egov.model.instrument.InstrumentHeader bounceInstrumentInfo,
                                                            org.egov.commons.EgwStatus receiptStatus,
                                                            boolean isReconciled)

updateReceiptHeaderStatus

@Transactional
public void updateReceiptHeaderStatus(ReceiptHeader receiptHeader,
                                                     org.egov.commons.EgwStatus status,
                                                     boolean isReconciled)

This method updates the status and reconciliation flag for the given receipt

Parameters:

receiptHeader - ReceiptHeader objects whose status and reconciliation flag have to be modified

status - a EgwStatus instance representing the state to which the receipt has to be updated with

isReconciled - a Boolean flag indicating the value for the reconciliation status

reconcileOnlineSuccessPayment

@Transactional
public ReceiptHeader reconcileOnlineSuccessPayment(ReceiptHeader onlinePaymentReceiptHeader,
                                                                  Date txnDate,
                                                                  String txnRefNo,
                                                                  BigDecimal txnAmount,
                                                                  String txnAuthStatus,
                                                                  List<ReceiptDetail> reconstructedList,
                                                                  ReceiptDetail debitAccountDetail)

setCollectionsUtil

public void setCollectionsUtil(CollectionsUtil collectionsUtil)

setFinancialsUtil

public void setFinancialsUtil(FinancialsUtil financialsUtil)

setPersistenceService

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

setChallanService

public void setChallanService(ChallanService challanService)