org.egov.billsaccounting.services

Class CreateVoucher

java.lang.Object

org.egov.billsaccounting.services.CreateVoucher

@Service
public class CreateVoucher
extends Object

This Class will create voucher from bill

Author:

Manikanta created on 15-sep-2008

Constructor Summary

Constructors

Constructor and Description
CreateVoucher()

Method Summary

Modifier and Type	Method and Description
protected void	checkMandatoryField(String fieldName, Object value, HashMap<String,Object> headerdetails, List<String> mandatoryFields)
org.egov.commons.CVoucherHeader	createPreApprovedVoucher(HashMap<String,Object> headerdetails, List<HashMap<String,Object>> accountcodedetails, List<HashMap<String,Object>> subledgerdetails) This API is to create a voucher from the list of HashMap values that are passed.
List<Transaxtion>	createTransaction(HashMap<String,Object> headerdetails, List<HashMap<String,Object>> accountcodedetails, List<HashMap<String,Object>> subledgerdetails, org.egov.commons.CVoucherHeader vh)
org.egov.commons.CVoucherHeader	createVoucher(HashMap<String,Object> headerdetails, List<HashMap<String,Object>> accountcodedetails, List<HashMap<String,Object>> subledgerdetails) This API is to create a voucher from the list of HashMap values that are passed.
long	createVoucherFromBill(int billId, String voucherStatus, String voucherNumber, Date voucherDate) creates voucher From billId
long	createVoucherFromBillForPJV(int billId, String voucherStatus, List<PreApprovedVoucher> voucherdetailList, List<PreApprovedVoucher> subLedgerList) creates voucher From billId
void	createVoucherFromPreApprovedVoucher(long vouhcerheaderid, String status)
org.egov.commons.CVoucherHeader	createVoucherHeader(HashMap<String,Object> headerdetails)
org.egov.commons.Vouchermis	createVouchermis(HashMap<String,Object> headerdetails)
void	deleteVoucherdetailAndGL(org.egov.commons.CVoucherHeader vh)
org.egov.infra.admin.master.service.AppConfigService	getAppConfigService()
org.egov.infra.admin.master.service.AppConfigValueService	getAppConfigValuesService()
protected String	getCgnType(String vouType)
String	getCGVNNumber(org.egov.commons.CVoucherHeader vh)
org.egov.commons.dao.FinancialYearDAO	getFinancialYearDAO()
String	getFiscalPeriod(String vDate)
org.egov.commons.Functionary	getFunctionaryByCode(BigDecimal code)
protected List<String>	getHeaderMandateFields()
org.egov.infstr.services.PersistenceService	getPersistenceService()
org.egov.pims.commons.Position	getPosition()
protected void	insertIntoVoucherHeader(org.egov.commons.CVoucherHeader vh)
boolean	isUniqueVN(String vcNum, String vcDate)
org.egov.commons.CVoucherHeader	reverseVoucher(List<HashMap<String,Object>> paramList) HashMap voucher details to reverse a voucher
void	setAppConfigService(org.egov.infra.admin.master.service.AppConfigService appConfigService)
void	setAppConfigValuesService(org.egov.infra.admin.master.service.AppConfigValueService appConfigValuesService)
void	setFinancialYearDAO(org.egov.commons.dao.FinancialYearDAO financialYearDAO)
void	setPersistenceService(org.egov.infstr.services.PersistenceService persistenceService)
void	startWorkflow(ContraJournalVoucher cjv) Deprecated.
void	startWorkflow(org.egov.commons.CVoucherHeader voucherheader) action name ////// check all junits, EisCommonsManger is added in create voucher constructor voucher service need to pass
void	startWorkflowForCashUpdate(org.egov.commons.CVoucherHeader voucherHeader) only for contra workflow
void	updatePJV(org.egov.commons.CVoucherHeader vh, List<PreApprovedVoucher> detailList, List<PreApprovedVoucher> subledgerlist)
void	validateBankDetails(HashMap<String,Object> receiptdetails)
void	validateInstrumentdetails(List<HashMap<String,Object>> instrumentdetailsList, HashMap<String,Object> receiptdetails)
void	validateMandateFields(HashMap<String,Object> headerdetails)
protected void	validateMandotyFields(HashMap<String,Object> headerdetails)
void	validateReceiptDetails(HashMap<String,Object> receiptdetails)
void	validateTransaction(List<HashMap<String,Object>> accountcodedetails, List<HashMap<String,Object>> subledgerdetails)
void	validateVoucherHeader(org.egov.commons.CVoucherHeader voucherHeader)
void	validateVoucherMIS(HashMap<String,Object> headerdetails) This method will validate all the master data that are passed.

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateVoucher

public CreateVoucher()

Method Detail

createVoucherFromBill

public long createVoucherFromBill(int billId,
                                  String voucherStatus,
                                  String voucherNumber,
                                  Date voucherDate)
                           throws org.egov.infra.exception.ApplicationRuntimeException,
                                  SQLException,
                                  TaskFailedException

creates voucher From billId

Parameters:

billId -

voucherDate - TODO

Returns:

voucherheaderId long

Throws:

org.egov.infra.exception.ApplicationRuntimeException

SQLException

Exception

TaskFailedException

createVoucherFromBillForPJV

public long createVoucherFromBillForPJV(int billId,
                                        String voucherStatus,
                                        List<PreApprovedVoucher> voucherdetailList,
                                        List<PreApprovedVoucher> subLedgerList)
                                 throws org.egov.infra.exception.ApplicationRuntimeException,
                                        SQLException,
                                        TaskFailedException

creates voucher From billId

Parameters:

billId -

Returns:

voucherheaderId long

Throws:

org.egov.infra.exception.ApplicationRuntimeException

SQLException

Exception

TaskFailedException

createVoucherFromPreApprovedVoucher

public void createVoucherFromPreApprovedVoucher(long vouhcerheaderid,
                                                String status)
                                         throws org.egov.infra.exception.ApplicationRuntimeException

Parameters:

vouhcerheaderid - - the vouhcerheaderid of the preapproved voucher.

status - - status of the vouchers.

Throws:

org.egov.infra.exception.ApplicationRuntimeException

createPreApprovedVoucher

@Transactional
public org.egov.commons.CVoucherHeader createPreApprovedVoucher(HashMap<String,Object> headerdetails,
                                                                               List<HashMap<String,Object>> accountcodedetails,
                                                                               List<HashMap<String,Object>> subledgerdetails)
                                                                        throws org.egov.infra.exception.ApplicationRuntimeException,
                                                                               org.egov.infra.validation.exception.ValidationException

This API is to create a voucher from the list of HashMap values that are passed. This will take care of various types of vouchers like -receipt, payments and journal vouchers

Parameters:

headerdetails -

HashMap headerdetails will have the data required for the voucher header and mis :

vouchername -This will be the name of the voucher, will need to set the values from enumeration (mandatory)

vouchertype -This will be the type of the voucher, will need to set the values from enumeration (mandatory)

description -This will be the description of the voucher (optional)

vouchernumber - This will be the vouchernumber if not set will be populated (optional)

voucherdate - This is the date on which the voucher needs to be created (mandatory)

fundid - This will be the id from the fund master (mandatory)

moduleid - This will be the id from module master,(not present now). Any external system sending data needs to set the value for this . If value not set will take as null (optional)

divisionid - This is the fieldid from the boundary master (optional)

departmentid - This is the departmentid from the department master (optional)

fundsourceid - This is the fundsourceid from the fund source master (optional)

schemeid - This is the schemeid from the scheme master (optional)

subschemeid - This is the subschemeid from the subscheme master (optional)

status - This is the status of voucher . If not set will be taken care (optional)

originalvoucher - This is the reference voucherid in care of reversal voucher (optional)

refvoucher - This the reference voucherheaderid in case of dependency vouchers (optional)

budgetCheckReq -Boolean- This is a flag set in vouchermis and decided whether budget check should be done or not . 'true' is yes 'false' is no . Default is 'true' (optional).

accountcodedetails -

HashMap accountcodedetails will have data required for the ledger details

glcodeid - This the ledger codeid from the chartofaccounts master. (mandatory)

debitamount - This is the debit amount for that voucher (optional)

creditamount - This is the credit amount for that voucher (optional)

functionid - This is the functionid from the function master (optional)

narration -This is the narration if any for that account code (optional)

subledgerdetails -

HashMap subledgerdetails will have the subledger details only for all the control codes in the voucher.

glcodeid -This the ledger codeid from the chartofaccounts master. (mandatory)

detailtypeid - This is the detailtypeid from the detailtype object (mandatory)

detailkeyid - This is the detailkey from the detailkey object (mandatory) - This is the amount for that detailkey (mandatory) - This is the id from the recovery master.If the glcode used is mapped in the recovery master then this data is mandatory.

Returns:

voucherheader object in case of success and null in case of fail.

Throws:

org.egov.infra.exception.ApplicationRuntimeException

org.egov.infra.validation.exception.ValidationException

startWorkflow

public void startWorkflow(org.egov.commons.CVoucherHeader voucherheader)
                   throws org.egov.infra.validation.exception.ValidationException

action name ////// check all junits, EisCommonsManger is added in create voucher constructor voucher service need to pass

Parameters:

voucherheader -

Throws:

org.egov.infra.validation.exception.ValidationException

startWorkflow

@Deprecated
public void startWorkflow(ContraJournalVoucher cjv)
                               throws org.egov.infra.validation.exception.ValidationException

Deprecated.

Throws:

org.egov.infra.validation.exception.ValidationException

startWorkflowForCashUpdate

public void startWorkflowForCashUpdate(org.egov.commons.CVoucherHeader voucherHeader)
                                throws org.egov.infra.validation.exception.ValidationException

only for contra workflow

Parameters:

voucherHeader -

Throws:

org.egov.infra.validation.exception.ValidationException - Uses VoucherWorkflow since contra and brv workflows are same

getPosition

public org.egov.pims.commons.Position getPosition()
                                           throws org.egov.infra.exception.ApplicationRuntimeException

Throws:

org.egov.infra.exception.ApplicationRuntimeException

createVoucher

@Transactional
public org.egov.commons.CVoucherHeader createVoucher(HashMap<String,Object> headerdetails,
                                                                    List<HashMap<String,Object>> accountcodedetails,
                                                                    List<HashMap<String,Object>> subledgerdetails)
                                                             throws org.egov.infra.exception.ApplicationRuntimeException

This API is to create a voucher from the list of HashMap values that are passed. This will take care of various types of vouchers like -receipt, payments and journal vouchers

Parameters:

headerdetails -

HashMap headerdetails will have the data required for the voucher header and mis :

vouchername -This will be the name of the voucher, will need to set the values from enumeration (mandatory)

vouchertype -This will be the type of the voucher, will need to set the values from enumeration (mandatory)

description -This will be the description of the voucher (optional)

vouchernumber - This will be the vouchernumber if not set will be populated (optional)

voucherdate - This is the date on which the voucher needs to be created (mandatory)

fundid - This will be the id from the fund master (mandatory)

functionid - This is the functionid from the function master (optional)

moduleid - This will be the id from module master,(not present now). Any external system sending data needs to set the value for this . If value not set will take as null (optional)

divisionid - This is the fieldid from the boundary master (optional)

departmentid - This is the departmentid from the department master (optional)

fundsourceid - This is the fundsourceid from the fund source master (optional)

schemeid - This is the schemeid from the scheme master (optional)

subschemeid - This is the subschemeid from the subscheme master (optional)

status - This is the status of voucher . If not set will be taken care (optional)

originalvoucher - This is the reference voucherid in care of reversal voucher (optional)

refvoucher - This the reference voucherheaderid in case of dependency vouchers (optional)

vouchersubtype - This is the sub voucher type in case of Journals where there are various kinds (optional)

budgetCheckReq -Boolean- This is a flag set in vouchermis and decided whether budget check should be done or not . 'true' is yes 'false' is no . Default is 'true' (optional).

billid-this is the bill number for which voucher is getting created . (optional)

accountcodedetails -

HashMap accountcodedetails will have data required for the ledger details

glcodeid - This the ledger codeid from the chartofaccounts master. (mandatory)

debitamount - This is the debit amount for that voucher (optional)

creditamount - This is the credit amount for that voucher (optional)

functionid - This is the functionid from the function master (optional)

narration -This is the narration if any for that account code (optional)

subledgerdetails -

HashMap subledgerdetails will have the subledger details only for all the control codes in the voucher.

glcodeid -This the ledger codeid from the chartofaccounts master. (mandatory)

detailtypeid - This is the detailtypeid from the detailtype object (mandatory)

detailkeyid - This is the detailkey from the detailkey object (mandatory) - This is the amount for that detailkey (mandatory) - This is the id from the recovery master.If the glcode used is mapped in the recovery master then this data is mandatory.

Returns:

voucherheader object in case of success and null in case of fail.

Throws:

org.egov.infra.exception.ApplicationRuntimeException

insertIntoVoucherHeader

protected void insertIntoVoucherHeader(org.egov.commons.CVoucherHeader vh)
                                throws org.egov.infra.exception.ApplicationRuntimeException

Throws:

org.egov.infra.exception.ApplicationRuntimeException

getCgnType

protected String getCgnType(String vouType)

validateVoucherMIS

public void validateVoucherMIS(HashMap<String,Object> headerdetails)
                        throws org.egov.infra.exception.ApplicationRuntimeException

This method will validate all the master data that are passed. This will also check if the data send are correct with respect to the inter master dependency.

Parameters:

headerdetails -

Throws:

org.egov.infra.exception.ApplicationRuntimeException

validateMandateFields

public void validateMandateFields(HashMap<String,Object> headerdetails)

createVoucherHeader

@Transactional
public org.egov.commons.CVoucherHeader createVoucherHeader(HashMap<String,Object> headerdetails)
                                                                   throws org.egov.infra.exception.ApplicationRuntimeException,
                                                                          Exception

Throws:

org.egov.infra.exception.ApplicationRuntimeException

Exception

createVouchermis

@Transactional
public org.egov.commons.Vouchermis createVouchermis(HashMap<String,Object> headerdetails)
                                                            throws org.egov.infra.exception.ApplicationRuntimeException

Throws:

org.egov.infra.exception.ApplicationRuntimeException

validateTransaction

public void validateTransaction(List<HashMap<String,Object>> accountcodedetails,
                                List<HashMap<String,Object>> subledgerdetails)
                         throws org.egov.infra.exception.ApplicationRuntimeException,
                                Exception

Throws:

org.egov.infra.exception.ApplicationRuntimeException

Exception

createTransaction

public List<Transaxtion> createTransaction(HashMap<String,Object> headerdetails,
                                           List<HashMap<String,Object>> accountcodedetails,
                                           List<HashMap<String,Object>> subledgerdetails,
                                           org.egov.commons.CVoucherHeader vh)
                                    throws org.egov.infra.exception.ApplicationRuntimeException

Throws:

org.egov.infra.exception.ApplicationRuntimeException

getFunctionaryByCode

public org.egov.commons.Functionary getFunctionaryByCode(BigDecimal code)

validateVoucherHeader

public void validateVoucherHeader(org.egov.commons.CVoucherHeader voucherHeader)

validateReceiptDetails

public void validateReceiptDetails(HashMap<String,Object> receiptdetails)

validateBankDetails

public void validateBankDetails(HashMap<String,Object> receiptdetails)

validateInstrumentdetails

public void validateInstrumentdetails(List<HashMap<String,Object>> instrumentdetailsList,
                                      HashMap<String,Object> receiptdetails)

Parameters:

instrumentdetails -

updatePJV

public void updatePJV(org.egov.commons.CVoucherHeader vh,
                      List<PreApprovedVoucher> detailList,
                      List<PreApprovedVoucher> subledgerlist)
               throws org.egov.infra.exception.ApplicationRuntimeException

Throws:

org.egov.infra.exception.ApplicationRuntimeException

deleteVoucherdetailAndGL

public void deleteVoucherdetailAndGL(org.egov.commons.CVoucherHeader vh)
                              throws SQLException,
                                     org.egov.infra.exception.ApplicationRuntimeException

Throws:

SQLException

org.egov.infra.exception.ApplicationRuntimeException

reverseVoucher

@Transactional
public org.egov.commons.CVoucherHeader reverseVoucher(List<HashMap<String,Object>> paramList)
                                                              throws org.egov.infra.exception.ApplicationRuntimeException,
                                                                     ParseException

HashMap voucher details to reverse a voucher

Original voucher header id -long- is the voucher header id of the voucher to be reversed later callled originalvoucher

Reversal voucher name -String - name of the reversal voucher (mandatory)

Reversal voucher type -String - type of the reversal voucher (mandatory)

Reversal voucher date - Date('dd/MM/yyyy') date of the reversal vocuher

Reversal voucher number - String - voucher number of reversal voucher Newly created voucher is called reversal voucher

Parameters:

paramList -

Returns:

Throws:

org.egov.infra.exception.ApplicationRuntimeException

ParseException

validateMandotyFields

protected void validateMandotyFields(HashMap<String,Object> headerdetails)

checkMandatoryField

protected void checkMandatoryField(String fieldName,
                                   Object value,
                                   HashMap<String,Object> headerdetails,
                                   List<String> mandatoryFields)

getHeaderMandateFields

protected List<String> getHeaderMandateFields()

getCGVNNumber

public String getCGVNNumber(org.egov.commons.CVoucherHeader vh)

getAppConfigService

public org.egov.infra.admin.master.service.AppConfigService getAppConfigService()

setAppConfigService

public void setAppConfigService(org.egov.infra.admin.master.service.AppConfigService appConfigService)

getPersistenceService

public org.egov.infstr.services.PersistenceService getPersistenceService()

setPersistenceService

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

getFinancialYearDAO

public org.egov.commons.dao.FinancialYearDAO getFinancialYearDAO()

setFinancialYearDAO

public void setFinancialYearDAO(org.egov.commons.dao.FinancialYearDAO financialYearDAO)

getAppConfigValuesService

public org.egov.infra.admin.master.service.AppConfigValueService getAppConfigValuesService()

setAppConfigValuesService

public void setAppConfigValuesService(org.egov.infra.admin.master.service.AppConfigValueService appConfigValuesService)

isUniqueVN

public boolean isUniqueVN(String vcNum,
                          String vcDate)
                   throws Exception,
                          TaskFailedException

Throws:

Exception

TaskFailedException

getFiscalPeriod

public String getFiscalPeriod(String vDate)
                       throws TaskFailedException

Throws:

TaskFailedException