org.egov.dao.budget

Class BudgetDetailsHibernateDAO

java.lang.Object

org.egov.dao.budget.BudgetDetailsHibernateDAO

All Implemented Interfaces:

BudgetDetailsDAO

@Transactional(readOnly=true)
public class BudgetDetailsHibernateDAO
extends Object
implements BudgetDetailsDAO

Author:

Administrator TODO To change the template for this generated type comment go to Window - Preferences - Java - Code Style - Code Templates

Field Summary

Fields

Modifier and Type	Field and Description
protected org.egov.infra.script.service.ScriptService	scriptService
protected org.egov.infra.persistence.utils.ApplicationSequenceNumberGenerator	sequenceGenerator

Constructor Summary

Constructors

Constructor and Description
BudgetDetailsHibernateDAO()

Method Summary

Modifier and Type	Method and Description
boolean	budgetaryCheck(Map<String,Object> paramMap) This API is handling the budget checking
boolean	budgetaryCheckForBill(Map<String,Object> paramMap) This API is handling the budget checking
boolean	consumeEncumbranceBudget(Long financialyearid, Integer moduleid, String referencenumber, Integer departmentid, Long functionid, Integer functionaryid, Integer schemeid, Integer subschemeid, Integer boundaryid, List<Long> budgetheadid, Integer fundid, double amount, String appropriationnumber)
boolean	consumeEncumbranceBudget(Map<String,Object> detailsMap) This API is to check whether the planning budget is available or not.For the amount passed if there is sufficient budget available API will return TRUE.
BudgetUsage	consumeEncumbranceBudget(String appropriationnumber, Long financialyearid, Integer moduleid, String referencenumber, Integer departmentid, Long functionid, Integer functionaryid, Integer schemeid, Integer subschemeid, Integer boundaryid, List<Long> budgetheadid, Integer fundid, double amount) Deprecated.
BudgetDetail	create(BudgetDetail entity)
void	delete(BudgetDetail entity)
List<BudgetDetail>	findAll()
BudgetDetail	findById(Number id, boolean lock)
BigDecimal	getActualBudgetUtilized(Map<String,Object> paramMap) API to load the budget consumed for the previous year/current year.
BigDecimal	getActualBudgetUtilizedForBudgetaryCheck(Map<String,Object> paramMap) API to load the budget consumed for the previous year/current year.
Map<String,BigDecimal>	getAggregateBudgetedAmtForYear(Map<String,Object> paramMap) This parameter HashMap contains deptid,functionid, functionaryid,schemeid, subschemeid,boundaryid,budgetheadid,financialyearid it'll get the budgeted amount based on the parameters.
org.egov.infra.admin.master.service.AppConfigValueService	getAppConfigValuesService()
BigDecimal	getBillAmountForBudgetCheck(Map<String,Object> paramMap)
String	getBudgetApprNumber(Map<String,Object> paramMap)
List<BudgetDetail>	getBudgetDetailsByBudgetGroupId(Long budgetGroupId)
List<BudgetDetail>	getBudgetDetailsByBudgetId(Long budgetId)
BigDecimal	getBudgetedAmtForYear(Map<String,Object> paramMap) This parameter HashMap contains deptid,functionid, functionaryid,schemeid, subschemeid,boundaryid,budgetheadid,financialyearid it'll get the budgeted amount based on the parameters.
BigDecimal	getBudgetedAmtForYearAsOnDate(Map<String,Object> paramMap, Date asOnDate) This parameter HashMap contains deptid,functionid, functionaryid,schemeid, subschemeid,boundaryid,budgetheadid,financialyearid it'll get the budgeted amount based on the parameters.
BigDecimal	getBudgetedAmtForYearRegardingBEorRE(Map<String,Object> paramMap, String typeBeRe) This parameter HashMap contains deptid,functionid, functionaryid,schemeid, subschemeid,boundaryid,budgetheadid,financialyearid,typeBeRe it'll get the budgeted amount based on the parameters.
List<BudgetGroup>	getBudgetHeadByGlcode(org.egov.commons.CChartOfAccounts coa) To get the Budgetgroup for the glcode at detailcode level or minorcode level or major code level.
List<BudgetGroup>	getBudgetHeadForGlcodeList(List<org.egov.commons.CChartOfAccounts> coa) To get the Budgetgroup for the glcode at detailcode level for a list of COA codes
org.hibernate.Session	getCurrentSession()
protected List<String>	getFieldConfigValues()
List<org.egov.commons.CFunction>	getFunctionsByFundAndDepartment(Integer fund, Long department) Returns a list of Functions having entry in budget detail with the given fund and department .
List<BudgetUsage>	getListBudgetUsage(Map<String,Object> queryParamMap)
org.egov.infstr.services.PersistenceService	getPersistenceService()
BigDecimal	getPlannigBudgetBy(Integer fundId, Integer deptId, Date asOnDate1) returns sum(approved BE/RE amount + appropriated (addition-deduction) amount)* mutliplicationFactor if budget and reappropriation both doesnot exist it will return zero
BigDecimal	getPlanningBudgetAvailable(Long financialyearid, Integer departmentid, Long functionid, Integer functionaryid, Integer schemeid, Integer subschemeid, Integer boundaryid, List<Long> budgetheadid, Integer fundid) To get the planning budget available amount
BigDecimal	getPlanningBudgetUsage(BudgetDetail bd)
BigDecimal	getPlanningPercentForYear(Map<String,Object> paramMap)
String	getQuery(Class clazz, Serializable id, String queryString)
BigDecimal	getSanctionedPlanningBudget(Map<String,Object> paramMap)
org.egov.infra.persistence.utils.ApplicationSequenceNumberGenerator	getSequenceGenerator()
void	releaseEncumbranceBudget(Long financialyearid, Integer moduleid, String referencenumber, Integer departmentid, Long functionid, Integer functionaryid, Integer schemeid, Integer subschemeid, Integer boundaryid, List<Long> budgetheadid, Integer fundid, double amount, String appropriationnumber) Deprecated.
boolean	releaseEncumbranceBudget(Map<String,Object> detailsMap) This API will be called for releasing the budget that was already allocated to some estimate or purchase order.
BudgetUsage	releaseEncumbranceBudget(String appropriationnumber, Long financialyearid, Integer moduleid, String referencenumber, Integer departmentid, Long functionid, Integer functionaryid, Integer schemeid, Integer subschemeid, Integer boundaryid, List<Long> budgetheadid, Integer fundid, double amount) This does the same as the above API except this returns the BudgetUsage object that is modified.
void	setAppConfigValuesService(org.egov.infra.admin.master.service.AppConfigValueService appConfigValuesService)
void	setBudgetService(BudgetService budgetService)
void	setPersistenceService(org.egov.infstr.services.PersistenceService persistenceService)
void	setSequenceGenerator(org.egov.infra.persistence.utils.ApplicationSequenceNumberGenerator sequenceGenerator)
BudgetDetail	update(BudgetDetail entity)

Methods inherited from class java.lang.Object

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

Field Detail

scriptService

@Autowired
protected org.egov.infra.script.service.ScriptService scriptService

sequenceGenerator

@Autowired
protected org.egov.infra.persistence.utils.ApplicationSequenceNumberGenerator sequenceGenerator

Constructor Detail

BudgetDetailsHibernateDAO

public BudgetDetailsHibernateDAO()

Method Detail

update

@Transactional
public BudgetDetail update(BudgetDetail entity)

Specified by:

update in interface BudgetDetailsDAO

create

@Transactional
public BudgetDetail create(BudgetDetail entity)

Specified by:

create in interface BudgetDetailsDAO

delete

@Transactional
public void delete(BudgetDetail entity)

Specified by:

delete in interface BudgetDetailsDAO

findAll

public List<BudgetDetail> findAll()

Specified by:

findAll in interface BudgetDetailsDAO

getCurrentSession

public org.hibernate.Session getCurrentSession()

consumeEncumbranceBudget

public boolean consumeEncumbranceBudget(Map<String,Object> detailsMap)

This API is to check whether the planning budget is available or not.For the amount passed if there is sufficient budget available API will return TRUE. Else it will return FALSE. At any point the budgetavailable will show the right picture of how much more we can plan for.

Assumptions- 1) on load of the budget there will be budgetavailable amount loaded using the multiplier factor. 2) on load of supplementary budget budget available is recalculated and updated.

For the sake of audit we should be updating the budgetusage object with the reference object and the moduleid and amount for any budget consumed. This will be used for reporting as to which object consumed how much and when.

Parameters:

financialyearid - This is the id from the financial year object

moduleid - This is the id of the module, say for payroll 7 and for stores 8 and for PTIS it is 2

referencenumber - This is the module object reference number, say purchase order number or estimate number

departmentid - This is the id of the department object

functionid - This is the id of the function object

functionaryid - This is the id of the functionary object

schemeid - This is the id of the scheme object

subschemeid - This is the id of the sub scheme object

boundaryid - This is the id of the boundary object

budgetheadid - This is the id of budgegroup object

amount - This is the amount of which budget needs to be allocated

Returns:

boolean

Throws:

Exception

consumeEncumbranceBudget

public boolean consumeEncumbranceBudget(Long financialyearid,
                                        Integer moduleid,
                                        String referencenumber,
                                        Integer departmentid,
                                        Long functionid,
                                        Integer functionaryid,
                                        Integer schemeid,
                                        Integer subschemeid,
                                        Integer boundaryid,
                                        List<Long> budgetheadid,
                                        Integer fundid,
                                        double amount,
                                        String appropriationnumber)

Specified by:

consumeEncumbranceBudget in interface BudgetDetailsDAO

consumeEncumbranceBudget

@Deprecated
public BudgetUsage consumeEncumbranceBudget(String appropriationnumber,
                                                        Long financialyearid,
                                                        Integer moduleid,
                                                        String referencenumber,
                                                        Integer departmentid,
                                                        Long functionid,
                                                        Integer functionaryid,
                                                        Integer schemeid,
                                                        Integer subschemeid,
                                                        Integer boundaryid,
                                                        List<Long> budgetheadid,
                                                        Integer fundid,
                                                        double amount)

Deprecated.

Does the same as the above API. Except this API returns BudgetUsage object if the available amount is >=0. If there is insufficient available amount then null is returned. Note that the first parameter is a String, unlike the previous API.

Specified by:

consumeEncumbranceBudget in interface BudgetDetailsDAO

Parameters:

appropriationnumber -

financialyearid -

moduleid -

referencenumber -

departmentid -

functionid -

functionaryid -

schemeid -

subschemeid -

boundaryid -

budgetheadid -

fundid -

amount -

Returns:

BudgetUsage

releaseEncumbranceBudget

public boolean releaseEncumbranceBudget(Map<String,Object> detailsMap)

This API will be called for releasing the budget that was already allocated to some estimate or purchase order. On calling this the amount that was allocated to some entity will get released. Budget available will be increased.

On modify of any entity they should first call the release budget and then call the consume budget. The budget usage table needs to be updated anytime this is invoked with the date and reference object number.

Parameters:

detailsMap - is the map containig following fields financialyearid This is the id from the financial year object moduleid This is the id of the module, say for payroll 7 and for stores 8 and for PTIS it is 2 referencenumber This is the module object reference number, say purchase order number or estimate number departmentid This is the id of the department object functionid This is the id of the function object functionaryid This is the id of the functionary object schemeid This is the id of the scheme object subschemeid This is the id of the sub scheme object fieldid This is the id of the boundary object budgetheadid This is the id of budgegroup object amount This is the amount of which budget needs to be allocated

Throws:

Exception

releaseEncumbranceBudget

@Deprecated
public void releaseEncumbranceBudget(Long financialyearid,
                                                 Integer moduleid,
                                                 String referencenumber,
                                                 Integer departmentid,
                                                 Long functionid,
                                                 Integer functionaryid,
                                                 Integer schemeid,
                                                 Integer subschemeid,
                                                 Integer boundaryid,
                                                 List<Long> budgetheadid,
                                                 Integer fundid,
                                                 double amount,
                                                 String appropriationnumber)

Deprecated.

Specified by:

releaseEncumbranceBudget in interface BudgetDetailsDAO

releaseEncumbranceBudget

@Transactional
public BudgetUsage releaseEncumbranceBudget(String appropriationnumber,
                                                           Long financialyearid,
                                                           Integer moduleid,
                                                           String referencenumber,
                                                           Integer departmentid,
                                                           Long functionid,
                                                           Integer functionaryid,
                                                           Integer schemeid,
                                                           Integer subschemeid,
                                                           Integer boundaryid,
                                                           List<Long> budgetheadid,
                                                           Integer fundid,
                                                           double amount)

This does the same as the above API except this returns the BudgetUsage object that is modified. Please note that first parameter is a string.

Specified by:

releaseEncumbranceBudget in interface BudgetDetailsDAO

Parameters:

appropriationnumber -

financialyearid -

moduleid -

referencenumber -

departmentid -

functionid -

functionaryid -

schemeid -

subschemeid -

boundaryid -

budgetheadid -

fundid -

amount -

Returns:

BudgetUsage object

getFieldConfigValues

protected List<String> getFieldConfigValues()

getPlanningBudgetAvailable

public BigDecimal getPlanningBudgetAvailable(Long financialyearid,
                                             Integer departmentid,
                                             Long functionid,
                                             Integer functionaryid,
                                             Integer schemeid,
                                             Integer subschemeid,
                                             Integer boundaryid,
                                             List<Long> budgetheadid,
                                             Integer fundid)

To get the planning budget available amount

Specified by:

getPlanningBudgetAvailable in interface BudgetDetailsDAO

Parameters:

financialyearid -

departmentid -

functionid -

functionaryid -

schemeid -

subschemeid -

boundaryid -

budgetheadid -

Returns:

getActualBudgetUtilized

public BigDecimal getActualBudgetUtilized(Map<String,Object> paramMap)

API to load the budget consumed for the previous year/current year. it'll return the transaction amount consumed for the current year based on asOnDate or previous financial year and other given parameters from Generalledger. Transaction amount calculation for Income and Liabilities -> sum(creditamt) - sum (debitamt) Transaction amount calculation for Expense and Assets -> sum(debitamt) - sum (creditamt)

Specified by:

getActualBudgetUtilized in interface BudgetDetailsDAO

Parameters:

functionid - (optional) -id for Function object

functionaryid - (optional) - id for functionary object

departmentid - (optional) - id for department object

schemeid - (optional) - id for scheme object

subschemeid - (optional) - id for subscheme object

boundaryid - (optional) - id for boundary object

budgetHead - (mandatory) - budget head object, which having the major code/ minor code/ detailcode/ range of minor/detail codes (based on appconfig values)

asOnDate - (mandatory)-

Returns:

transaction amount

getActualBudgetUtilizedForBudgetaryCheck

public BigDecimal getActualBudgetUtilizedForBudgetaryCheck(Map<String,Object> paramMap)

API to load the budget consumed for the previous year/current year. it'll return the transaction amount consumed for the current year based on asOnDate or previous financial year and other given parameters from Generalledger. Transaction amount calculation for Income and Liabilities -> sum(creditamt) - sum (debitamt) Transaction amount calculation for Expense and Assets -> sum(debitamt) - sum (creditamt)

Specified by:

getActualBudgetUtilizedForBudgetaryCheck in interface BudgetDetailsDAO

Parameters:

functionid - (optional) -id for Function object

functionaryid - (optional) - id for functionary object

departmentid - (optional) - id for department object

schemeid - (optional) - id for scheme object

subschemeid - (optional) - id for subscheme object

boundaryid - (optional) - id for boundary object

budgetHead - (mandatory) - budget head object, which having the major code/ minor code/ detailcode/ range of minor/detail codes (based on appconfig values)

asOnDate - (mandatory)-

Returns:

transaction amount

getPlanningBudgetUsage

public BigDecimal getPlanningBudgetUsage(BudgetDetail bd)

Specified by:

getPlanningBudgetUsage in interface BudgetDetailsDAO

getBudgetedAmtForYear

public BigDecimal getBudgetedAmtForYear(Map<String,Object> paramMap)

This parameter HashMap contains deptid,functionid, functionaryid,schemeid, subschemeid,boundaryid,budgetheadid,financialyearid it'll get the budgeted amount based on the parameters.

Specified by:

getBudgetedAmtForYear in interface BudgetDetailsDAO

Parameters:

paramMap -

Returns:

budgeted amount

getBudgetedAmtForYearAsOnDate

public BigDecimal getBudgetedAmtForYearAsOnDate(Map<String,Object> paramMap,
                                                Date asOnDate)

This parameter HashMap contains deptid,functionid, functionaryid,schemeid, subschemeid,boundaryid,budgetheadid,financialyearid it'll get the budgeted amount based on the parameters.

Specified by:

getBudgetedAmtForYearAsOnDate in interface BudgetDetailsDAO

Parameters:

paramMap -

Returns:

budgeted amount

getPlanningPercentForYear

public BigDecimal getPlanningPercentForYear(Map<String,Object> paramMap)

Specified by:

getPlanningPercentForYear in interface BudgetDetailsDAO

getAggregateBudgetedAmtForYear

public Map<String,BigDecimal> getAggregateBudgetedAmtForYear(Map<String,Object> paramMap)

This parameter HashMap contains deptid,functionid, functionaryid,schemeid, subschemeid,boundaryid,budgetheadid,financialyearid it'll get the budgeted amount based on the parameters. Only financial year parameter will be considered mandatory here.

Specified by:

getAggregateBudgetedAmtForYear in interface BudgetDetailsDAO

Parameters:

paramMap -

Returns:

budgeted amount

budgetaryCheck

public boolean budgetaryCheck(Map<String,Object> paramMap)

This API is handling the budget checking

Specified by:

budgetaryCheck in interface BudgetDetailsDAO

Parameters:

paramMap - paramMap contains 1. debitAmt (mandatory) 2. creditAmt (mandatory) 3. deptid (optional) 4. functionid (optional) 5. functionaryid (optional) 6. schemeid (optional) 7. subschemeid (optional) 8. boundaryid (optional) 9. glcode (mandatory) - based on the glcode, we can get the budgetheadid 10. asondate (manadtory) - to get the actuals, we need asondate 11. mis.budgetcheckreq-Boolean- (optional) to skip budget check if set to false.Default is true Budget checking will be enabled or disabled by these levels and in the order a. Application - uses set up "Budget Control Type" b. Voucherlevel - uses budgetcheckreq column of vouchermis table for perticular voucher c. Debit or Credit level - uses Budgetgroup.budgetting type for debit side only ,credit side or both d. Glcode level - Uses chartofaccounts.budgetcheckreq fieled to decide budget checking .

Returns:

getBudgetApprNumber

public String getBudgetApprNumber(Map<String,Object> paramMap)

Parameters:

paramMap -

Returns:

getBudgetHeadByGlcode

public List<BudgetGroup> getBudgetHeadByGlcode(org.egov.commons.CChartOfAccounts coa)

To get the Budgetgroup for the glcode at detailcode level or minorcode level or major code level.

Specified by:

getBudgetHeadByGlcode in interface BudgetDetailsDAO

Parameters:

coa -

paramMap -

Returns:

getBudgetHeadForGlcodeList

public List<BudgetGroup> getBudgetHeadForGlcodeList(List<org.egov.commons.CChartOfAccounts> coa)

To get the Budgetgroup for the glcode at detailcode level for a list of COA codes

Specified by:

getBudgetHeadForGlcodeList in interface BudgetDetailsDAO

Parameters:

coa -

paramMap -

Returns:

getQuery

public String getQuery(Class clazz,
                       Serializable id,
                       String queryString)

budgetaryCheckForBill

public boolean budgetaryCheckForBill(Map<String,Object> paramMap)

This API is handling the budget checking

Specified by:

budgetaryCheckForBill in interface BudgetDetailsDAO

Parameters:

paramMap - paramMap contains 1. debitAmt (mandatory) 2. creditAmt (mandatory) 3. deptid (optional) 4. functionid (optional) 5. functionaryid (optional) 6. schemeid (optional) 7. subschemeid (optional) 8. boundaryid (optional) 9. glcode (mandatory) - based on the glcode, we can get the budgetheadid 10. asondate (manadtory) - to get the actuals, we need asondate 11.mis.budgetcheckreq-Boolean-(optional) set to false if budget check not to be done for this bill default is True.

Returns:

getBillAmountForBudgetCheck

public BigDecimal getBillAmountForBudgetCheck(Map<String,Object> paramMap)

Specified by:

getBillAmountForBudgetCheck in interface BudgetDetailsDAO

getBudgetedAmtForYearRegardingBEorRE

public BigDecimal getBudgetedAmtForYearRegardingBEorRE(Map<String,Object> paramMap,
                                                       String typeBeRe)

This parameter HashMap contains deptid,functionid, functionaryid,schemeid, subschemeid,boundaryid,budgetheadid,financialyearid,typeBeRe it'll get the budgeted amount based on the parameters.

Specified by:

getBudgetedAmtForYearRegardingBEorRE in interface BudgetDetailsDAO

Parameters:

paramMap -

Returns:

budgeted amount

getSanctionedPlanningBudget

public BigDecimal getSanctionedPlanningBudget(Map<String,Object> paramMap)

Specified by:

getSanctionedPlanningBudget in interface BudgetDetailsDAO

Parameters:

parameter - Map contains deptid,functionid, functionaryid,schemeid, subschemeid,boundaryid,budgetheadid,financialyearid,fundid it'll get the budgeted amount based on the parameters.

Returns:

Sanctioned Planning Budget amount

getListBudgetUsage

public List<BudgetUsage> getListBudgetUsage(Map<String,Object> queryParamMap)

Specified by:

getListBudgetUsage in interface BudgetDetailsDAO

Parameters:

queryParamMap - - HashMap queryParamMap will have data required for the query the queryParamMap contain values :- the mis attribute values passed in the query map will be validated with the appconfig value of key=budgetaryCheck_groupby_values financialyearid - optional ExecutionDepartmentId - mandatory -if:department present in the app config value - optional -else fundId - mandatory -if:fund present in the app config value - optional -else schemeId - mandatory -if:Scheme present in the app config value - optional -else functionId - mandatory -if:function present in the app config value - optional -else subschemeId - mandatory -if:Subscheme present in the app config value - optional -else functionaryId - mandatory -if:functionary present in the app config value - optional -else boundaryId - mandatory -if:boundary present in the app config value - optional -else moduleId - optional financialYearId -optional budgetgroupId -optional fromDate -optional toDate -optional Order By - optional if passed then only Budgetary appropriation number and reference number is accepted, if not passed then default order by is date.

Returns:

getPlannigBudgetBy

public BigDecimal getPlannigBudgetBy(Integer fundId,
                                     Integer deptId,
                                     Date asOnDate1)

returns sum(approved BE/RE amount + appropriated (addition-deduction) amount)* mutliplicationFactor if budget and reappropriation both doesnot exist it will return zero

Specified by:

getPlannigBudgetBy in interface BudgetDetailsDAO

Parameters:

fundId -

deptId -

asOnDate -

Returns:

getFunctionsByFundAndDepartment

public List<org.egov.commons.CFunction> getFunctionsByFundAndDepartment(Integer fund,
                                                                        Long department)

Returns a list of Functions having entry in budget detail with the given fund and department .

Specified by:

getFunctionsByFundAndDepartment in interface BudgetDetailsDAO

Parameters:

fund,function,department - and account type

getBudgetDetailsByBudgetGroupId

public List<BudgetDetail> getBudgetDetailsByBudgetGroupId(Long budgetGroupId)

getBudgetDetailsByBudgetId

public List<BudgetDetail> getBudgetDetailsByBudgetId(Long budgetId)

getSequenceGenerator

public org.egov.infra.persistence.utils.ApplicationSequenceNumberGenerator getSequenceGenerator()

setSequenceGenerator

public void setSequenceGenerator(org.egov.infra.persistence.utils.ApplicationSequenceNumberGenerator sequenceGenerator)

getPersistenceService

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

setPersistenceService

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

setBudgetService

public void setBudgetService(BudgetService budgetService)

getAppConfigValuesService

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

setAppConfigValuesService

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

findById

public BudgetDetail findById(Number id,
                             boolean lock)

Specified by:

findById in interface BudgetDetailsDAO