org.kuali.kra.budget.calculator

Class AbstractBudgetCalculator

java.lang.Object

org.kuali.kra.budget.calculator.AbstractBudgetCalculator

Direct Known Subclasses:

LineItemCalculator, PersonnelLineItemCalculator

public abstract class AbstractBudgetCalculator
extends Object

Base class for LineItemCalculator and PersonnelLineItemCalculator.

Field Summary

Fields

Modifier and Type	Field and Description
protected Budget	budget
protected BudgetLineItemBase	budgetLineItem

Constructor Summary

Constructors

Constructor and Description
AbstractBudgetCalculator(Budget budget, BudgetLineItemBase budgetLineItem) Constructs a CalculatorBase.java.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	addCalculatedAmount(AbstractBudgetCalculatedAmount budgetCalculatedAmount)
void	calculate() This method does the calculation for each line item.
protected void	calculateBreakUpInterval()
protected void	createAndCalculateBreakupIntervals()
List<Boundary>	createBreakupBoundaries(QueryList<AbstractBudgetRate> qlCombinedRates, Date liStartDate, Date liEndDate) Use the combined & sorted Prop & LA rates to create Boundary objects.
protected void	createBreakUpInterval() Combine the sorted Prop & LA rates, which should be in sorted order(asc).
QueryList	filterRates(List rates) This method is for filtering rates and lab allocation rates.
protected List<BreakUpInterval>	getBreakupIntervals()
protected BudgetForm	getBudgetFormFromGlobalVariables()
protected BudgetRatesService	getBudgetRateService()
org.kuali.rice.krad.service.BusinessObjectService	getBusinessObjectService() Gets the businessObjectService attribute.
protected org.kuali.rice.core.api.datetime.DateTimeService	getDateTimeService()
QueryList<BudgetRate>	getInflationRates()
protected abstract AbstractBudgetCalculatedAmount	getNewCalculatedAmountInstance()
QueryList<BudgetLaRate>	getQlLineItemPropLaRates() Gets the qlLineItemPropLaRates attribute.
QueryList<BudgetRate>	getQlLineItemPropRates() Gets the qlLineItemPropRates attribute.
QueryList<BudgetRate>	getUnderrecoveryRates() Gets the underrecoveryRates attribute.
protected List<ValidCalcType>	getValidCalcTypes()
abstract void	populateApplicableCosts(Boundary boundary) Abstract method to populate the applicable cost and applicable cost sharing in boundary.
protected abstract void	populateBudgetRateBaseList() This abstract method should be implemented by LineItemCalculator and PersonnelLineItemCalculator.
protected abstract void	populateCalculatedAmountLineItems()
protected void	setBreakupIntervals(List<BreakUpInterval> breakupIntervals)
void	setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService) Sets the businessObjectService attribute value.
void	setCalculatedAmounts(Budget budget, BudgetLineItemBase budgetLineItem)
void	setInflationRates(QueryList<BudgetRate> inflationRates)
protected void	setInfltionValidCalcCeRates(QueryList<ValidCeRateType> infltionValidCalcCeRates)
void	setQlLineItemPropLaRates(QueryList<BudgetLaRate> qlLineItemPropLaRates) Sets the qlLineItemPropLaRates attribute value.
void	setQlLineItemPropRates(QueryList<BudgetRate> qlLineItemPropRates) Sets the qlLineItemPropRates attribute value.
void	setUnderrecoveryRates(QueryList<BudgetRate> underrecoveryRates) Sets the underrecoveryRates attribute value.
protected void	updateBudgetLineItemCalculatedAmounts() This method is for populating the calculated amounts by looking at the rate class and rate type for each line item gets applied to.

Methods inherited from class java.lang.Object

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

Field Detail

budget

protected Budget budget

budgetLineItem

protected BudgetLineItemBase budgetLineItem

Constructor Detail

AbstractBudgetCalculator

public AbstractBudgetCalculator(Budget budget,
                        BudgetLineItemBase budgetLineItem)

Constructs a CalculatorBase.java.

Parameters:

budget -

budgetLineItem -

Method Detail

populateApplicableCosts

public abstract void populateApplicableCosts(Boundary boundary)

Abstract method to populate the applicable cost and applicable cost sharing in boundary. For LineItemCalculator, applicableCost would be the line item cost and for PersonnelLineItemCalculator applicable cost would be cumulative salary of all personnel line item

Parameters:

boundary -

filterRates

public QueryList filterRates(List rates)

This method is for filtering rates and lab allocation rates.

Parameters:

rates -

Returns:

calculate

public void calculate()

This method does the calculation for each line item. Both BudgetLineItem and BudgetPersonnelLineItem invokes this method to do the calculation.

populateBudgetRateBaseList

protected abstract void populateBudgetRateBaseList()

This abstract method should be implemented by LineItemCalculator and PersonnelLineItemCalculator. It is for populating the RateAndBase amounts.

updateBudgetLineItemCalculatedAmounts

protected void updateBudgetLineItemCalculatedAmounts()

This method is for populating the calculated amounts by looking at the rate class and rate type for each line item gets applied to.

createAndCalculateBreakupIntervals

protected void createAndCalculateBreakupIntervals()

createBreakUpInterval

protected void createBreakUpInterval()

Combine the sorted Prop & LA rates, which should be in sorted order(asc). Now create the breakup boundaries and use it to create breakup intervals and set all the values required for calculation. Then call calculateBreakupInterval method for each AmountBean for setting the calculated cost & calculated cost sharing ie for each rate class & rate type.

createBreakupBoundaries

public List<Boundary> createBreakupBoundaries(QueryList<AbstractBudgetRate> qlCombinedRates,
                                     Date liStartDate,
                                     Date liEndDate)

Use the combined & sorted Prop & LA rates to create Boundary objects. Each Boundary will contain start date & end date. Check whether any rate changes, and break at this point to create a new boundary.

Returns:

List of boundary objects

calculateBreakUpInterval

protected void calculateBreakUpInterval()

getValidCalcTypes

protected List<ValidCalcType> getValidCalcTypes()

populateCalculatedAmountLineItems

protected abstract void populateCalculatedAmountLineItems()

setCalculatedAmounts

public final void setCalculatedAmounts(Budget budget,
                        BudgetLineItemBase budgetLineItem)

setInfltionValidCalcCeRates

protected void setInfltionValidCalcCeRates(QueryList<ValidCeRateType> infltionValidCalcCeRates)

getNewCalculatedAmountInstance

protected abstract AbstractBudgetCalculatedAmount getNewCalculatedAmountInstance()

addCalculatedAmount

protected abstract void addCalculatedAmount(AbstractBudgetCalculatedAmount budgetCalculatedAmount)

getBusinessObjectService

public org.kuali.rice.krad.service.BusinessObjectService getBusinessObjectService()

Gets the businessObjectService attribute.

Returns:

Returns the businessObjectService.

setBusinessObjectService

public void setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)

Sets the businessObjectService attribute value.

Parameters:

businessObjectService - The businessObjectService to set.

getBreakupIntervals

protected List<BreakUpInterval> getBreakupIntervals()

setBreakupIntervals

protected void setBreakupIntervals(List<BreakUpInterval> breakupIntervals)

getDateTimeService

protected org.kuali.rice.core.api.datetime.DateTimeService getDateTimeService()

getUnderrecoveryRates

public QueryList<BudgetRate> getUnderrecoveryRates()

Gets the underrecoveryRates attribute.

Returns:

Returns the underrecoveryRates.

setUnderrecoveryRates

public void setUnderrecoveryRates(QueryList<BudgetRate> underrecoveryRates)

Sets the underrecoveryRates attribute value.

Parameters:

underrecoveryRates - The underrecoveryRates to set.

getInflationRates

public QueryList<BudgetRate> getInflationRates()

setInflationRates

public void setInflationRates(QueryList<BudgetRate> inflationRates)

getQlLineItemPropLaRates

public QueryList<BudgetLaRate> getQlLineItemPropLaRates()

Gets the qlLineItemPropLaRates attribute.

Returns:

Returns the qlLineItemPropLaRates.

setQlLineItemPropLaRates

public void setQlLineItemPropLaRates(QueryList<BudgetLaRate> qlLineItemPropLaRates)

Sets the qlLineItemPropLaRates attribute value.

Parameters:

qlLineItemPropLaRates - The qlLineItemPropLaRates to set.

getQlLineItemPropRates

public QueryList<BudgetRate> getQlLineItemPropRates()

Gets the qlLineItemPropRates attribute.

Returns:

Returns the qlLineItemPropRates.

setQlLineItemPropRates

public void setQlLineItemPropRates(QueryList<BudgetRate> qlLineItemPropRates)

Sets the qlLineItemPropRates attribute value.

Parameters:

qlLineItemPropRates - The qlLineItemPropRates to set.

getBudgetFormFromGlobalVariables

protected BudgetForm getBudgetFormFromGlobalVariables()

getBudgetRateService

protected BudgetRatesService getBudgetRateService()