org.egov.works.services

Interface ContractorBillService

All Superinterfaces:

BaseService<ContractorBillRegister,Long>

All Known Implementing Classes:

ContractorBillServiceImpl

public interface ContractorBillService
extends BaseService<ContractorBillRegister,Long>

This class will have all business logic related to Contractor Bill.

Author:

Sathish P

Method Summary

Modifier and Type	Method and Description
BigDecimal	calculateTotalPendingAdvance(BigDecimal totalAdvancePaid, Date billDate, WorkOrderEstimate workOrderEstimate, Long billId) The method return BigDecimal
boolean	contractorBillNumberChangeRequired(org.egov.model.bills.EgBillregister bill, WorkOrder workOrder, org.egov.commons.CFinancialYear financialYear) The method return true if the bill number has to be re-generated
String	generateContractorBillNumber(ContractorBillRegister contractorBillRegister) The method return number if the bill number has to be generated
List<org.egov.model.bills.EgBilldetails>	getAccountDetailsList(Long billId, Long workOrderEstimateId, List<StatutoryDeductionsForBill> statutoryList, List<DeductionTypeForBill> standardDeductionList, List<org.egov.model.bills.EgBilldetails> customDeductionList, List<org.egov.model.bills.EgBilldetails> retentionMoneyDeductionList) Get the accountDetails
BigDecimal	getAdvanceAdjustmentAmountForBill(Long billId, Long workOrderEstimateId) API will returns the Advance adjustment amount for a given bill Id
BigDecimal	getApprovedMBAmount(Long workOrderId, Long estimateId, Date asOnDate) This method will return cumulative amount for all approved MB for a given workorder
BigDecimal	getApprovedMBAmountforBill(ContractorBillRegister contractorBillRegister) This method will return Bill amount for a given BIll
BigDecimal	getApprovedMBAmountOfTenderedItems(Long workOrderId, Long workOrderEstimateId, Date billDate) This method will return cumulative tendered items amount for all approved MB for a given workorder
BigDecimal	getApprovedMBAmountOfTenderedItemsForBill(ContractorBillRegister contractorBillRegister) This method will return Bill amount for a given BIll considering only tendered items
Collection<AssetForBill>	getAssetAndAccountDetails(List<AssetForBill> accountDetailsForBill)
List<AssetForBill>	getAssetForBill(Long billId) API will returns the AssetForBill list for a given bill Id
BigDecimal	getBilledAmount(AbstractEstimate estimate) This method returns total billed amount including overheads for the project till today in the current financial year.
BigDecimal	getBilledAmountForDate(AbstractEstimate estimate, Date asOnDate) This method returns total billed amount including overheads for the project till asOnDate across financial years.
List	getBillType() This method will get the bill type from App Config Value.
List<org.egov.commons.CChartOfAccounts>	getBudgetHeadForDepositCOA(AbstractEstimate estimate) This method will return the work done budget head from the mapping table, based on the deposit COA in the financial details of the estimate
List<org.egov.model.bills.EgBilldetails>	getCustomDeductionList(Long billId, Long workOrderEstimateId, List<StatutoryDeductionsForBill> statutoryList, List<DeductionTypeForBill> standardDeductionList, List<org.egov.model.bills.EgBilldetails> retentionMoneyDeductionList) Get the list of custom dedcution based on glcodes of custom deduction
List<org.egov.model.bills.EgBilldetails>	getCustomDeductionListforglcodes(List<BigDecimal> glcodeIdList, Long billId) API will returns the custom deduction list of egbilldetails excluding glcode
Collection<org.egov.model.bills.EgBilldetails>	getCustomDeductionTypes(List<org.egov.model.bills.EgBilldetails> customDeductions)
List<org.egov.infstr.models.EgChecklists>	getEgcheckList(Long billId) Get the EgChecklists
Object[]	getLatestMBCreatedDateAndRefNo(Long woId, Long estId) returns latest MB created date and its reference no
List<org.egov.model.bills.EgBillregister>	getListOfApprovedBillforEstimate(AbstractEstimate estimate, Date date) This method will return List of Approved Bill for a given Estimate and date
List<org.egov.model.bills.EgBillregister>	getListOfNonCancelledBillsforEstimate(AbstractEstimate estimate, Date date) This method will return List of Not cancelled for a given Estimate and date
List<MBHeader>	getMbListForBillAndWorkordrId(Long workOrderId, Long billId) Get the mbList
List<MBForCancelledBill>	getMbListForCancelBill(Long billId) Get the mbList
BigDecimal	getNetPayableAmountForGlCodeId(Long billId) API will returns the Net Payable Amount for netpayable code coaId
BigDecimal	getNetPaybleCode(Long billId) Get the netpayblecode
List<Integer>	getProjCodeIdsListForDepositCode(Integer fundId, Long coaId, Long depositCodeId)
List<org.egov.model.bills.EgBilldetails>	getRetentionMoneyDeductionList(Long billId, List<StatutoryDeductionsForBill> statutoryList, List<DeductionTypeForBill> standardDeductionList) Get the list of retention money dedcution based on glcodes of retention deduction
Collection<org.egov.model.bills.EgBilldetails>	getRetentionMoneyTypes(List<org.egov.model.bills.EgBilldetails> retentionMoneyDeductions)
List<String>	getSortedDeductionsFromConfig(String Key) API will returns the required order deduction names list from appconfig based on key such as statutory/standard deduction
List<DeductionTypeForBill>	getStandardDeductionForBill(Long billId) API will returns the standard deduction list for a given bill Id
Map<String,String[]>	getStandardDeductionsFromConfig() API will returns the Standard deduction types as key and its mapped COA as map values
List<DeductionTypeForBill>	getStandardDeductionSortedOrder(List<String> requiredOrder, List<DeductionTypeForBill> givenStandardList) API will returns the sorted Deduction list for a given bill Id
Collection<DeductionTypeForBill>	getStandardDeductionTypes(List<DeductionTypeForBill> standardDeductions)
Collection<StatutoryDeductionsForBill>	getStatutoryDeductions(List<StatutoryDeductionsForBill> actionStatutorydetails)
List<StatutoryDeductionsForBill>	getStatutoryDeductionSortedOrder(List<String> requiredOrder, List<StatutoryDeductionsForBill> givenStatutoryList) API will returns the type of Deduction list for a given bill Id and type
List<StatutoryDeductionsForBill>	getStatutoryListForBill(Long billId) API will returns the type of Deduction list for a given bill Id and type
Double	getTotalActualExpenseForProject(AbstractEstimate estimate, Date asonDate) This method returns total expense incurred including overheads for the project if project is closed till asonDate,otherwise sum of all approved bills for the project till given date.
BigDecimal	getTotalExpenditure(List<Integer> projectCodeIdsList, String accDetailType)
BigDecimal	getTotalValueWoForUptoBillDate(Date billDate, Long workOrderId, Long workOrderEstimateId) API will returns the Total value for the workorder upto billdate
BigDecimal	getTotAmtForAdvanceAdjustment(Date billDate, Long workOrderId, Long workOrderEstimateId) API will returns the Total Amount for advanceAjustment deduction for work order estimate upto billdate
BigDecimal	getTotAmtForCustom(Date billDate, Long workOrderId, org.egov.model.bills.EgBilldetails egBilldetails, Long workOrderEstimateId) API will returns the Total Amount for custom deduction for workorder upto billdate
BigDecimal	getTotAmtForStandard(Date billDate, Long workOrderId, DeductionTypeForBill deductionTypeForBill, Long workOrderEstimateId) API will returns the Total Amount for custom deduction for workorder upto billdate
BigDecimal	getTotAmtForStatutory(Date billDate, Long workOrderId, StatutoryDeductionsForBill statDeductionBilldetail, Long workOrderEstimateId) API will returns the Total Amount for Statutory deduction for workorder upto billdate for that dedcution
BigDecimal	getUtlizedAmountForUnArrovedBill(Long workOrderId, Date asOnDate) Get sum of all bill of given work orders which are still unapproved.
List<String>	searchContractorBill(Map<String,Object> paramsMap, List<Object> paramList) Get the list of eligible bills based on parameters provided
void	setAllViewLists(Long id, Long workOrderId, Long workOrderEstimateId, List<StatutoryDeductionsForBill> actionStatutorydetails, List<DeductionTypeForBill> standardDeductions, List<org.egov.model.bills.EgBilldetails> customDeductions, List<org.egov.model.bills.EgBilldetails> retentionMoneyDeductions, List<AssetForBill> accountDetailsForBill)
List<WorkCompletionDetailInfo>	setWorkCompletionDetailInfoList(WorkOrderEstimate workOrderEstimate) Get the List of WorkCompletionDetailInfo for completion certificate
WorkCompletionInfo	setWorkCompletionInfoFromBill(ContractorBillRegister contractorBillRegister, WorkOrderEstimate workOrderEstimate) Get the WorkCompletionInfo for completion certificate
String	validateForBudgetHeadInWorkflow(Set<org.egov.model.bills.EgBilldetails> billDetails, AbstractEstimate estimate) This method will set the flag which is used to hide the Forward/Approve buttons for the bills in workflow where the budget heads do not match

Methods inherited from interface org.egov.works.services.BaseService

create, delete, find, find, findAll, findAllBy, findAllByNamedQuery, findByExample, findById, findByNamedQuery, getCurrentFinancialYear, merge, persist, update

Method Detail

getBillType

List getBillType()

This method will get the bill type from App Config Value.

Returns:

contractorBillNumberChangeRequired

boolean contractorBillNumberChangeRequired(org.egov.model.bills.EgBillregister bill,
                                           WorkOrder workOrder,
                                           org.egov.commons.CFinancialYear financialYear)

The method return true if the bill number has to be re-generated

Parameters:

bill - an instance of EgBillregister containing the bill date

financialYear - an instance of CFinancialYear representing the financial year for the estimate date.

Returns:

a boolean value indicating if the bill number change is required.

generateContractorBillNumber

String generateContractorBillNumber(ContractorBillRegister contractorBillRegister)

The method return number if the bill number has to be generated

Parameters:

bill - an instance of EgBillregister containing the bill date representing the financial year.

workOrder - an instance of WorkOrder representing the executing department.

Returns:

a boolean value indicating if the bill number change is required.

getUtlizedAmountForUnArrovedBill

BigDecimal getUtlizedAmountForUnArrovedBill(Long workOrderId,
                                            Date asOnDate)

Get sum of all bill of given work orders which are still unapproved.

Parameters:

workOrderId -

Returns:

getApprovedMBAmount

BigDecimal getApprovedMBAmount(Long workOrderId,
                               Long estimateId,
                               Date asOnDate)

This method will return cumulative amount for all approved MB for a given workorder

Parameters:

workOrderId -

Returns:

calculateTotalPendingAdvance

BigDecimal calculateTotalPendingAdvance(BigDecimal totalAdvancePaid,
                                        Date billDate,
                                        WorkOrderEstimate workOrderEstimate,
                                        Long billId)

The method return BigDecimal

Parameters:

totalAdvancePaid - , billDate, workOrderEstimate

workOrder - an instance of WorkOrder.

Returns:

a BigDecimal value indicating total Advance pending for given Work Order Estimate as on bill date before this current bill

getStandardDeductionsFromConfig

Map<String,String[]> getStandardDeductionsFromConfig()

API will returns the Standard deduction types as key and its mapped COA as map values

Returns:

map containing deduction type as key and string array of coa glcodes

searchContractorBill

List<String> searchContractorBill(Map<String,Object> paramsMap,
                                  List<Object> paramList)

Get the list of eligible bills based on parameters provided

Parameters:

paramsMap -

paramList - TODO

Returns:

getTotalValueWoForUptoBillDate

BigDecimal getTotalValueWoForUptoBillDate(Date billDate,
                                          Long workOrderId,
                                          Long workOrderEstimateId)

API will returns the Total value for the workorder upto billdate

Returns:

BigDecimal

getSortedDeductionsFromConfig

List<String> getSortedDeductionsFromConfig(String Key)

API will returns the required order deduction names list from appconfig based on key such as statutory/standard deduction

Returns:

List containing statutory deduction names

getStatutoryListForBill

List<StatutoryDeductionsForBill> getStatutoryListForBill(Long billId)

API will returns the type of Deduction list for a given bill Id and type

Returns:

List containing Statutory deduction names

getStatutoryDeductionSortedOrder

List<StatutoryDeductionsForBill> getStatutoryDeductionSortedOrder(List<String> requiredOrder,
                                                                  List<StatutoryDeductionsForBill> givenStatutoryList)

API will returns the type of Deduction list for a given bill Id and type

Returns:

List containing Statutory deduction names

getStandardDeductionForBill

List<DeductionTypeForBill> getStandardDeductionForBill(Long billId)

API will returns the standard deduction list for a given bill Id

Returns:

List containing Statutory deduction names

getStandardDeductionSortedOrder

List<DeductionTypeForBill> getStandardDeductionSortedOrder(List<String> requiredOrder,
                                                           List<DeductionTypeForBill> givenStandardList)

API will returns the sorted Deduction list for a given bill Id

Returns:

List containing Statutory deduction names

getAssetForBill

List<AssetForBill> getAssetForBill(Long billId)

API will returns the AssetForBill list for a given bill Id

Returns:

List containing AssetForBill

getAdvanceAdjustmentAmountForBill

BigDecimal getAdvanceAdjustmentAmountForBill(Long billId,
                                             Long workOrderEstimateId)

API will returns the Advance adjustment amount for a given bill Id

Returns:

BigDecimal

getCustomDeductionListforglcodes

List<org.egov.model.bills.EgBilldetails> getCustomDeductionListforglcodes(List<BigDecimal> glcodeIdList,
                                                                          Long billId)

API will returns the custom deduction list of egbilldetails excluding glcode

Returns:

BigDecimal

getNetPayableAmountForGlCodeId

BigDecimal getNetPayableAmountForGlCodeId(Long billId)
                                   throws NumberFormatException,
                                          org.egov.infra.exception.ApplicationException

API will returns the Net Payable Amount for netpayable code coaId

Returns:

BigDecimal

Throws:

NumberFormatException

org.egov.infra.exception.ApplicationException

getTotAmtForStatutory

BigDecimal getTotAmtForStatutory(Date billDate,
                                 Long workOrderId,
                                 StatutoryDeductionsForBill statDeductionBilldetail,
                                 Long workOrderEstimateId)

API will returns the Total Amount for Statutory deduction for workorder upto billdate for that dedcution

Returns:

BigDecimal

getTotAmtForAdvanceAdjustment

BigDecimal getTotAmtForAdvanceAdjustment(Date billDate,
                                         Long workOrderId,
                                         Long workOrderEstimateId)

API will returns the Total Amount for advanceAjustment deduction for work order estimate upto billdate

Returns:

BigDecimal

getTotAmtForStandard

BigDecimal getTotAmtForStandard(Date billDate,
                                Long workOrderId,
                                DeductionTypeForBill deductionTypeForBill,
                                Long workOrderEstimateId)

API will returns the Total Amount for custom deduction for workorder upto billdate

Returns:

BigDecimal

getTotAmtForCustom

BigDecimal getTotAmtForCustom(Date billDate,
                              Long workOrderId,
                              org.egov.model.bills.EgBilldetails egBilldetails,
                              Long workOrderEstimateId)

API will returns the Total Amount for custom deduction for workorder upto billdate

Returns:

BigDecimal

getCustomDeductionList

List<org.egov.model.bills.EgBilldetails> getCustomDeductionList(Long billId,
                                                                Long workOrderEstimateId,
                                                                List<StatutoryDeductionsForBill> statutoryList,
                                                                List<DeductionTypeForBill> standardDeductionList,
                                                                List<org.egov.model.bills.EgBilldetails> retentionMoneyDeductionList)
                                                         throws NumberFormatException,
                                                                org.egov.infra.exception.ApplicationException

Get the list of custom dedcution based on glcodes of custom deduction

Parameters:

billId - ,workOrderEstimateId,statutoryList,standardDeductionList, retentionMoneyDeductionList

Returns:

List

Throws:

org.egov.infra.exception.ApplicationException

NumberFormatException

getRetentionMoneyDeductionList

List<org.egov.model.bills.EgBilldetails> getRetentionMoneyDeductionList(Long billId,
                                                                        List<StatutoryDeductionsForBill> statutoryList,
                                                                        List<DeductionTypeForBill> standardDeductionList)
                                                                 throws NumberFormatException,
                                                                        org.egov.infra.exception.ApplicationException

Get the list of retention money dedcution based on glcodes of retention deduction

Parameters:

ContractorBillRegister -

Returns:

List

Throws:

org.egov.infra.exception.ApplicationException

NumberFormatException

getNetPaybleCode

BigDecimal getNetPaybleCode(Long billId)
                     throws Exception

Get the netpayblecode

Parameters:

billId - ,glcodeIdList

Returns:

BigDecimal

Throws:

org.egov.infra.exception.ApplicationException

NumberFormatException

Exception

getMbListForBillAndWorkordrId

List<MBHeader> getMbListForBillAndWorkordrId(Long workOrderId,
                                             Long billId)

Get the mbList

Parameters:

workOrderId - , billid

Returns:

List

getMbListForCancelBill

List<MBForCancelledBill> getMbListForCancelBill(Long billId)

Get the mbList

Parameters:

workOrderId - , billid

Returns:

List

getAccountDetailsList

List<org.egov.model.bills.EgBilldetails> getAccountDetailsList(Long billId,
                                                               Long workOrderEstimateId,
                                                               List<StatutoryDeductionsForBill> statutoryList,
                                                               List<DeductionTypeForBill> standardDeductionList,
                                                               List<org.egov.model.bills.EgBilldetails> customDeductionList,
                                                               List<org.egov.model.bills.EgBilldetails> retentionMoneyDeductionList)
                                                        throws NumberFormatException,
                                                               org.egov.infra.exception.ApplicationException

Get the accountDetails

Parameters:

statutoryList - ,standardDeductionList,customDeductionList,workOrderEstimateId

Returns:

List

Throws:

NumberFormatException

org.egov.infra.exception.ApplicationException

setAllViewLists

void setAllViewLists(Long id,
                     Long workOrderId,
                     Long workOrderEstimateId,
                     List<StatutoryDeductionsForBill> actionStatutorydetails,
                     List<DeductionTypeForBill> standardDeductions,
                     List<org.egov.model.bills.EgBilldetails> customDeductions,
                     List<org.egov.model.bills.EgBilldetails> retentionMoneyDeductions,
                     List<AssetForBill> accountDetailsForBill)
              throws NumberFormatException,
                     org.egov.infra.exception.ApplicationException

Parameters:

statutoryList - ,standardDeductionList,customDeductionList,workOrderEstimateId ,workOrderId, id(billId)

Throws:

NumberFormatException

org.egov.infra.exception.ApplicationException

getEgcheckList

List<org.egov.infstr.models.EgChecklists> getEgcheckList(Long billId)
                                                  throws NumberFormatException,
                                                         org.egov.infra.exception.ApplicationException

Get the EgChecklists

Parameters:

billid -

Returns:

List

Throws:

NumberFormatException

org.egov.infra.exception.ApplicationException

setWorkCompletionInfoFromBill

WorkCompletionInfo setWorkCompletionInfoFromBill(ContractorBillRegister contractorBillRegister,
                                                 WorkOrderEstimate workOrderEstimate)

Get the WorkCompletionInfo for completion certificate

Parameters:

ContractorBillRegister -

WorkOrderEstimate -

Returns:

WorkCompletionInfo

setWorkCompletionDetailInfoList

List<WorkCompletionDetailInfo> setWorkCompletionDetailInfoList(WorkOrderEstimate workOrderEstimate)

Get the List of WorkCompletionDetailInfo for completion certificate

Parameters:

WorkOrderEstimate -

Returns:

List

getApprovedMBAmountforBill

BigDecimal getApprovedMBAmountforBill(ContractorBillRegister contractorBillRegister)

This method will return Bill amount for a given BIll

Parameters:

billId -

Returns:

getApprovedMBAmountOfTenderedItemsForBill

BigDecimal getApprovedMBAmountOfTenderedItemsForBill(ContractorBillRegister contractorBillRegister)

This method will return Bill amount for a given BIll considering only tendered items

Parameters:

billId -

Returns:

getTotalActualExpenseForProject

Double getTotalActualExpenseForProject(AbstractEstimate estimate,
                                       Date asonDate)

This method returns total expense incurred including overheads for the project if project is closed till asonDate,otherwise sum of all approved bills for the project till given date.

Parameters:

estimate - ,date

Returns:

sum of total expense till date

getListOfApprovedBillforEstimate

List<org.egov.model.bills.EgBillregister> getListOfApprovedBillforEstimate(AbstractEstimate estimate,
                                                                           Date date)

This method will return List of Approved Bill for a given Estimate and date

Parameters:

estimate - ,date

Returns:

List of apporoved bills till date

getListOfNonCancelledBillsforEstimate

List<org.egov.model.bills.EgBillregister> getListOfNonCancelledBillsforEstimate(AbstractEstimate estimate,
                                                                                Date date)

This method will return List of Not cancelled for a given Estimate and date

Parameters:

estimate - ,date

Returns:

List of approved bills till date

getBilledAmount

BigDecimal getBilledAmount(AbstractEstimate estimate)

This method returns total billed amount including overheads for the project till today in the current financial year.

Parameters:

admin - sanctioned estimate

Returns:

BigDecimal

getBilledAmountForDate

BigDecimal getBilledAmountForDate(AbstractEstimate estimate,
                                  Date asOnDate)

This method returns total billed amount including overheads for the project till asOnDate across financial years.

Parameters:

admin - sanctioned estimate

Returns:

BigDecimal

getApprovedMBAmountOfTenderedItems

BigDecimal getApprovedMBAmountOfTenderedItems(Long workOrderId,
                                              Long workOrderEstimateId,
                                              Date billDate)

This method will return cumulative tendered items amount for all approved MB for a given workorder

Parameters:

workOrderId -

Returns:

getBudgetHeadForDepositCOA

List<org.egov.commons.CChartOfAccounts> getBudgetHeadForDepositCOA(AbstractEstimate estimate)

This method will return the work done budget head from the mapping table, based on the deposit COA in the financial details of the estimate

Parameters:

estimate -

Returns:

List

validateForBudgetHeadInWorkflow

String validateForBudgetHeadInWorkflow(Set<org.egov.model.bills.EgBilldetails> billDetails,
                                       AbstractEstimate estimate)

This method will set the flag which is used to hide the Forward/Approve buttons for the bills in workflow where the budget heads do not match

Parameters:

Set - billDetails, estimate

Returns:

string

getProjCodeIdsListForDepositCode

List<Integer> getProjCodeIdsListForDepositCode(Integer fundId,
                                               Long coaId,
                                               Long depositCodeId)

Parameters:

- - search fundId, coaId, depositCodeId

Returns:

- returns list of project codes

getTotalExpenditure

BigDecimal getTotalExpenditure(List<Integer> projectCodeIdsList,
                               String accDetailType)

Parameters:

- - search projectCodeIdsList, accDetailType

Returns:

- returns expenditure incurred

getLatestMBCreatedDateAndRefNo

Object[] getLatestMBCreatedDateAndRefNo(Long woId,
                                        Long estId)

returns latest MB created date and its reference no

Parameters:

estId - ,woId

Returns:

getStatutoryDeductions

Collection<StatutoryDeductionsForBill> getStatutoryDeductions(List<StatutoryDeductionsForBill> actionStatutorydetails)

getCustomDeductionTypes

Collection<org.egov.model.bills.EgBilldetails> getCustomDeductionTypes(List<org.egov.model.bills.EgBilldetails> customDeductions)

getRetentionMoneyTypes

Collection<org.egov.model.bills.EgBilldetails> getRetentionMoneyTypes(List<org.egov.model.bills.EgBilldetails> retentionMoneyDeductions)

getAssetAndAccountDetails

Collection<AssetForBill> getAssetAndAccountDetails(List<AssetForBill> accountDetailsForBill)

getStandardDeductionTypes

Collection<DeductionTypeForBill> getStandardDeductionTypes(List<DeductionTypeForBill> standardDeductions)