org.kuali.kra.budget.calculator

Class BudgetCalculationServiceImpl

java.lang.Object

org.kuali.kra.budget.calculator.BudgetCalculationServiceImpl

All Implemented Interfaces:

BudgetCalculationService

Direct Known Subclasses:

AwardBudgetCalculationServiceImpl

public class BudgetCalculationServiceImpl
extends Object
implements BudgetCalculationService

This class implements all methods declared in BudgetCalculationService

Constructor Summary

Constructors

Constructor and Description
BudgetCalculationServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addBudgetLimits(List<BudgetDecimal> budgetLimits, AwardBudgetLineItemCalculatedAmountExt awardCalcAmt, boolean isPrevBudget)
protected void	addBudgetLimits(List<BudgetDecimal> budgetLimits, AwardBudgetLineItemExt awardBudgetLineItem, boolean isPrevBudget)
protected void	addToLimit(List<BudgetDecimal> budgetLimits, List<BudgetDecimal> limits)
protected void	addTotals(Map<String,List<BudgetDecimal>> budgetLimitMap, Map<String,List<BudgetDecimal>> totalsMap)
void	applyToLaterPeriods(Budget budget, BudgetPeriod budgetPeriod, BudgetLineItem budgetLineItem) This method is to apply budgetlineitem details to all later periods
void	calculateAndSyncBudgetLineItem(Budget budget, BudgetLineItem budgetLineItem)
void	calculateAndSyncBudgetPeriod(Budget budget, BudgetPeriod budgetPeriod)
void	calculateBudget(Budget budget) This method is for calculating the entire budget version and populate the appropriate values to session (BudgetVersionOverView).
void	calculateBudgetLineItem(Budget budget, BudgetLineItem budgetLineItem) This method for calculating non-personnel budget line item.
void	calculateBudgetLineItem(Budget budget, BudgetPersonnelDetails budgetLineItem) This method for calculating non-personnel budget line item.
void	calculateBudgetPeriod(Budget budget, BudgetPeriod budgetPeriod) This method is for calculating the entire budget version and populate the appropriate values to session (BudgetVersionOverView).
void	calculateBudgetSummaryTotals(Budget budget) This method is to calculate the budget totals for budget total page
void	calculateBudgetTotals(Budget budget) This method is to calculate the budget totals for budget total page
protected SortedMap<RateType,List<BudgetDecimal>>	calculateExpenseTotals(Budget budget, boolean personnelFlag)
protected void	calculateNonPersonnelSummaryTotals(Budget budget)
void	calculateSalary(Budget budget, BudgetPersonnelDetails budgetPersonnelLineItem) This method...
protected SortedMap<BudgetCategoryType,List<CostElement>>	categorizeObjectCodesByCategory(Budget budget)
protected void	copyLineItemToPersonnelDetails(BudgetLineItem budgetLineItem, BudgetPersonnelDetails budgetPersonnelDetails)
protected RateType	createRateType(BudgetLineItemCalculatedAmount budgetLineItemCalculatedAmount)
protected void	ensureBudgetPeriodHasSyncedCosts(Budget budget) Ensures that a budget period has synced costs with other budget objects (i.e.
protected List<CostElement>	filterObjectCodesByBudgetCategoryType(Set<CostElement> objectCodes, String budgetCategoryType)
protected BudgetCommonService<BudgetParent>	getBudgetCommonService(Budget budget)
BudgetDistributionAndIncomeService	getBudgetDistributionAndIncomeService() Gets the budgetDistributionAndIncomeService attribute.
BudgetForm	getBudgetFormFromGlobalVariables()
List<Map<String,List<BudgetDecimal>>>	getBudgetLimitsTotals(String budgetId)
org.kuali.rice.krad.service.BusinessObjectService	getBusinessObjectService()
protected void	getFringeAndCalculatedCost(Map<String,List<BudgetDecimal>> personnelBudgetLimits, AwardBudgetLineItemExt awardBudgetLineItem, boolean isPrevBudget)
protected void	getNonPersonnelCalAmt(Map<String,List<BudgetDecimal>> personnelBudgetLimits, AwardBudgetLineItemExt awardBudgetLineItem, boolean isPrevBudget)
protected Map<String,List<BudgetDecimal>>	getNonPersonnelMap()
protected BudgetCategoryType	getPersonnelCategoryType()
protected Map<String,List<BudgetDecimal>>	getPersonnelMap()
protected void	getPreviousBudgetLimits(Long budgetId, Map<String,List<BudgetDecimal>> personnelBudgetLimits, Map<String,List<BudgetDecimal>> nonPersonnelBudgetLimits)
protected Map<String,List<BudgetDecimal>>	getTotalMap()
protected List<BudgetDecimal>	initBudgetLimits()
protected void	initCostDependentItems(Budget budget) Initializes items that are dependent on a cost value.
protected void	initCostSharing(Budget document) Clears and initializes the CostSharing in a budget document.
protected void	initUnrecoveredFandAs(Budget document) Clears and initializes the UnrecoveredFandAs in a budget document.
protected boolean	isCalculationRequired(Budget budget, BudgetPeriod budgetPeriod) Checks if a calculation is required where Budget periods must be synced in line items.
protected boolean	isPositiveTotalCostSharingAmount(Budget document) Checks if a positive Total CostSharing Amount exists in a line item or in a budget period.
protected boolean	isPositiveTotalUnderreoveryAmount(Budget document) Checks if a positive Total Underrecoverary Amount exists in a line item or in a budget period.
void	populateCalculatedAmount(Budget budget, BudgetLineItem budgetLineItem) This method is for calculating calculated amounts for each cost element.
void	populateCalculatedAmount(Budget budget, BudgetPersonnelDetails budgetPersonnelDetails) This method is for calculating calculated amounts for each cost element.
protected void	populateRateAndBase(BudgetLineItem bli, BudgetPersonnelDetails budgetPersonnelDetails, int rateNumber)
void	rePopulateCalculatedAmount(Budget budget, BudgetLineItem budgetLineItem) This method is for calculating calculated amounts for each cost element.
void	rePopulateCalculatedAmount(Budget budget, BudgetPersonnelDetails newBudgetPersonnelDetails) This method is for calculating calculated amounts for each cost element.
protected void	setBudgetCostsFromPeriods(Budget budget) This method sets the budget document's costs from the budget periods' costs.
void	setBudgetDistributionAndIncomeService(BudgetDistributionAndIncomeService service) Sets the budgetDistributionAndIncomeService attribute value.
protected void	setBudgetPeriodCostsFromLineItems(BudgetPeriod budgetPeriod) This method sets the budget period costs from the line item costs.
void	setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)
protected void	syncCostsToBudget(Budget budget) Syncs the calculated costs in the budget document with the calculated costs in the budget periods.
void	syncToPeriodCostLimit(Budget budget, BudgetPeriod budgetPeriod, BudgetLineItem budgetLineItem) This method is to adjust the line item cost to total cost limit of a period
void	syncToPeriodDirectCostLimit(Budget budget, BudgetPeriod budgetPeriod, BudgetLineItem budgetLineItem) This method is to adjust the line item cost to total direct cost limit of a period
void	updatePersonnelBudgetRate(BudgetLineItem budgetLineItem) Synchronize rates between BudgetLineItemCalculatedAmount instances and BudgetPersonnelCalculatedAmount instances in a Budget.

Methods inherited from class java.lang.Object

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

Constructor Detail

BudgetCalculationServiceImpl

public BudgetCalculationServiceImpl()

Method Detail

calculateBudget

public void calculateBudget(Budget budget)

Description copied from interface: BudgetCalculationService

This method is for calculating the entire budget version and populate the appropriate values to session (BudgetVersionOverView).

Specified by:

calculateBudget in interface BudgetCalculationService

See Also:

org.kuali.kra.budget.calculator.BudgetCalculationService#calculateBudget(java.lang.String, java.lang.Integer)

isCalculationRequired

protected boolean isCalculationRequired(Budget budget,
                            BudgetPeriod budgetPeriod)

Checks if a calculation is required where Budget periods must be synced in line items.

Parameters:

budgetLineItemDeleted - whether of not a budget line item has been deleted.

budgetPeriod - the current budget period.

Returns:

true if calculation is required false if not

copyLineItemToPersonnelDetails

protected void copyLineItemToPersonnelDetails(BudgetLineItem budgetLineItem,
                                  BudgetPersonnelDetails budgetPersonnelDetails)

calculateBudgetLineItem

public void calculateBudgetLineItem(Budget budget,
                           BudgetPersonnelDetails budgetLineItem)

Description copied from interface: BudgetCalculationService

This method for calculating non-personnel budget line item. This calculates all calculated amounts and sum it up to cost of the the line item. It populates the appropriate values to session as well. (BudgetLineItemCalculatedAmount, BudgetLineItem)

Specified by:

calculateBudgetLineItem in interface BudgetCalculationService

calculateBudgetLineItem

public void calculateBudgetLineItem(Budget budget,
                           BudgetLineItem budgetLineItem)

Description copied from interface: BudgetCalculationService

This method for calculating non-personnel budget line item. This calculates all calculated amounts and sum it up to cost of the the line item. It populates the appropriate values to session as well. (BudgetLineItemCalculatedAmount, BudgetLineItem)

Specified by:

calculateBudgetLineItem in interface BudgetCalculationService

See Also:

org.kuali.kra.budget.calculator.BudgetCalculationService#calculateBudgetLineItem(org.kuali.kra.budget.nonpersonnel.BudgetLineItem)

populateRateAndBase

protected void populateRateAndBase(BudgetLineItem bli,
                       BudgetPersonnelDetails budgetPersonnelDetails,
                       int rateNumber)

calculateAndSyncBudgetLineItem

public void calculateAndSyncBudgetLineItem(Budget budget,
                                  BudgetLineItem budgetLineItem)

populateCalculatedAmount

public void populateCalculatedAmount(Budget budget,
                            BudgetLineItem budgetLineItem)

Description copied from interface: BudgetCalculationService

This method is for calculating calculated amounts for each cost element. It looks at all applicable rates for a cost element and calculate all direct and indirect costs.

Specified by:

populateCalculatedAmount in interface BudgetCalculationService

See Also:

org.kuali.kra.budget.calculator.BudgetCalculationService#calculateCalculatedAmount(org.kuali.kra.budget.nonpersonnel.BudgetLineItem)

populateCalculatedAmount

public void populateCalculatedAmount(Budget budget,
                            BudgetPersonnelDetails budgetPersonnelDetails)

Description copied from interface: BudgetCalculationService

This method is for calculating calculated amounts for each cost element. It looks at all applicable rates for a cost element and calculate all direct and indirect costs.

Specified by:

populateCalculatedAmount in interface BudgetCalculationService

See Also:

org.kuali.kra.budget.calculator.BudgetCalculationService#calculateCalculatedAmount(org.kuali.kra.budget.nonpersonnel.BudgetLineItem)

calculateSalary

public void calculateSalary(Budget budget,
                   BudgetPersonnelDetails budgetPersonnelLineItem)

Description copied from interface: BudgetCalculationService

This method...

Specified by:

calculateSalary in interface BudgetCalculationService

See Also:

org.kuali.kra.budget.calculator.BudgetCalculationService#calculateSalary(org.kuali.kra.budget.personnel.BudgetPersonnelDetails)

calculateBudgetPeriod

public void calculateBudgetPeriod(Budget budget,
                         BudgetPeriod budgetPeriod)

Description copied from interface: BudgetCalculationService

This method is for calculating the entire budget version and populate the appropriate values to session (BudgetVersionOverView).

Specified by:

calculateBudgetPeriod in interface BudgetCalculationService

calculateAndSyncBudgetPeriod

public void calculateAndSyncBudgetPeriod(Budget budget,
                                BudgetPeriod budgetPeriod)

syncCostsToBudget

protected void syncCostsToBudget(Budget budget)

Syncs the calculated costs in the budget document with the calculated costs in the budget periods. If the certain costs are not positive then lists on items related to those costs are also cleared and reset (i.e. UnrecoveredFandAs). This method modifies the passed in Budget.

Parameters:

budget - the budget document

initCostDependentItems

protected void initCostDependentItems(Budget budget)

Initializes items that are dependent on a cost value. (i.e. UnrecoveredFandAs) This method modifies the passed in Budget.

Parameters:

budget - the budget document

initUnrecoveredFandAs

protected void initUnrecoveredFandAs(Budget document)

Clears and initializes the UnrecoveredFandAs in a budget document. This method modifies the passed in Budget.

Parameters:

document - the budget document.

initCostSharing

protected void initCostSharing(Budget document)

Clears and initializes the CostSharing in a budget document. This method modifies the passed in Budget.

Parameters:

document - the budget document.

ensureBudgetPeriodHasSyncedCosts

protected void ensureBudgetPeriodHasSyncedCosts(Budget budget)

Ensures that a budget period has synced costs with other budget objects (i.e. line items)

Parameters:

budgetLineItemDeleted - whether or not a budget line item has been deleted

currentPeriod - the current period.

setBudgetCostsFromPeriods

protected void setBudgetCostsFromPeriods(Budget budget)

This method sets the budget document's costs from the budget periods' costs. This method modifies the passed in budget document.

Parameters:

budget - the budget document to set the costs on.

setBudgetPeriodCostsFromLineItems

protected void setBudgetPeriodCostsFromLineItems(BudgetPeriod budgetPeriod)

This method sets the budget period costs from the line item costs. This method modifies the passed in budget period.

Parameters:

budgetPeriod - the budget periods to set the costs on.

isPositiveTotalUnderreoveryAmount

protected final boolean isPositiveTotalUnderreoveryAmount(Budget document)

Checks if a positive Total Underrecoverary Amount exists in a line item or in a budget period.

Parameters:

document - The budget Document

Returns:

true if positive.

isPositiveTotalCostSharingAmount

protected final boolean isPositiveTotalCostSharingAmount(Budget document)

Checks if a positive Total CostSharing Amount exists in a line item or in a budget period.

Parameters:

document - The budget Document

Returns:

true if positive.

categorizeObjectCodesByCategory

protected SortedMap<BudgetCategoryType,List<CostElement>> categorizeObjectCodesByCategory(Budget budget)

getPersonnelCategoryType

protected BudgetCategoryType getPersonnelCategoryType()

calculateBudgetSummaryTotals

public void calculateBudgetSummaryTotals(Budget budget)

Description copied from interface: BudgetCalculationService

This method is to calculate the budget totals for budget total page

Specified by:

calculateBudgetSummaryTotals in interface BudgetCalculationService

getBudgetCommonService

protected BudgetCommonService<BudgetParent> getBudgetCommonService(Budget budget)

calculateNonPersonnelSummaryTotals

protected void calculateNonPersonnelSummaryTotals(Budget budget)

filterObjectCodesByBudgetCategoryType

protected List<CostElement> filterObjectCodesByBudgetCategoryType(Set<CostElement> objectCodes,
                                                      String budgetCategoryType)

calculateExpenseTotals

protected SortedMap<RateType,List<BudgetDecimal>> calculateExpenseTotals(Budget budget,
                                                             boolean personnelFlag)

createRateType

protected RateType createRateType(BudgetLineItemCalculatedAmount budgetLineItemCalculatedAmount)

calculateBudgetTotals

public void calculateBudgetTotals(Budget budget)

Description copied from interface: BudgetCalculationService

This method is to calculate the budget totals for budget total page

Specified by:

calculateBudgetTotals in interface BudgetCalculationService

See Also:

BudgetCalculationService.calculateBudgetTotals(org.kuali.kra.budget.core.Budget)

syncToPeriodCostLimit

public void syncToPeriodCostLimit(Budget budget,
                         BudgetPeriod budgetPeriod,
                         BudgetLineItem budgetLineItem)

Description copied from interface: BudgetCalculationService

This method is to adjust the line item cost to total cost limit of a period

Specified by:

syncToPeriodCostLimit in interface BudgetCalculationService

syncToPeriodDirectCostLimit

public void syncToPeriodDirectCostLimit(Budget budget,
                               BudgetPeriod budgetPeriod,
                               BudgetLineItem budgetLineItem)

Description copied from interface: BudgetCalculationService

This method is to adjust the line item cost to total direct cost limit of a period

Specified by:

syncToPeriodDirectCostLimit in interface BudgetCalculationService

applyToLaterPeriods

public void applyToLaterPeriods(Budget budget,
                       BudgetPeriod budgetPeriod,
                       BudgetLineItem budgetLineItem)

Description copied from interface: BudgetCalculationService

This method is to apply budgetlineitem details to all later periods

Specified by:

applyToLaterPeriods in interface BudgetCalculationService

getBusinessObjectService

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

setBusinessObjectService

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

getBudgetDistributionAndIncomeService

public BudgetDistributionAndIncomeService getBudgetDistributionAndIncomeService()

Gets the budgetDistributionAndIncomeService attribute.

Returns:

Returns the budgetDistributionAndIncomeService.

setBudgetDistributionAndIncomeService

public void setBudgetDistributionAndIncomeService(BudgetDistributionAndIncomeService service)

Sets the budgetDistributionAndIncomeService attribute value.

Parameters:

budgetDistributionAndIncomeService - The budgetDistributionAndIncomeService to set.

rePopulateCalculatedAmount

public void rePopulateCalculatedAmount(Budget budget,
                              BudgetLineItem budgetLineItem)

Description copied from interface: BudgetCalculationService

This method is for calculating calculated amounts for each cost element. It looks at all applicable rates for a cost element and calculate all direct and indirect costs.

Specified by:

rePopulateCalculatedAmount in interface BudgetCalculationService

rePopulateCalculatedAmount

public void rePopulateCalculatedAmount(Budget budget,
                              BudgetPersonnelDetails newBudgetPersonnelDetails)

Description copied from interface: BudgetCalculationService

This method is for calculating calculated amounts for each cost element. It looks at all applicable rates for a cost element and calculate all direct and indirect costs.

Specified by:

rePopulateCalculatedAmount in interface BudgetCalculationService

updatePersonnelBudgetRate

public void updatePersonnelBudgetRate(BudgetLineItem budgetLineItem)

Description copied from interface: BudgetCalculationService

Synchronize rates between BudgetLineItemCalculatedAmount instances and BudgetPersonnelCalculatedAmount instances in a Budget.

Specified by:

updatePersonnelBudgetRate in interface BudgetCalculationService

Parameters:

budgetLineItem - BudgetLineItem instance to examine amounts for synchronization

getBudgetFormFromGlobalVariables

public BudgetForm getBudgetFormFromGlobalVariables()

Specified by:

getBudgetFormFromGlobalVariables in interface BudgetCalculationService

getBudgetLimitsTotals

public List<Map<String,List<BudgetDecimal>>> getBudgetLimitsTotals(String budgetId)

Specified by:

getBudgetLimitsTotals in interface BudgetCalculationService

getPreviousBudgetLimits

protected void getPreviousBudgetLimits(Long budgetId,
                           Map<String,List<BudgetDecimal>> personnelBudgetLimits,
                           Map<String,List<BudgetDecimal>> nonPersonnelBudgetLimits)

initBudgetLimits

protected List<BudgetDecimal> initBudgetLimits()

addTotals

protected void addTotals(Map<String,List<BudgetDecimal>> budgetLimitMap,
             Map<String,List<BudgetDecimal>> totalsMap)

addToLimit

protected void addToLimit(List<BudgetDecimal> budgetLimits,
              List<BudgetDecimal> limits)

addBudgetLimits

protected void addBudgetLimits(List<BudgetDecimal> budgetLimits,
                   AwardBudgetLineItemExt awardBudgetLineItem,
                   boolean isPrevBudget)

addBudgetLimits

protected void addBudgetLimits(List<BudgetDecimal> budgetLimits,
                   AwardBudgetLineItemCalculatedAmountExt awardCalcAmt,
                   boolean isPrevBudget)

getNonPersonnelMap

protected Map<String,List<BudgetDecimal>> getNonPersonnelMap()

getPersonnelMap

protected Map<String,List<BudgetDecimal>> getPersonnelMap()

getTotalMap

protected Map<String,List<BudgetDecimal>> getTotalMap()

getFringeAndCalculatedCost

protected void getFringeAndCalculatedCost(Map<String,List<BudgetDecimal>> personnelBudgetLimits,
                              AwardBudgetLineItemExt awardBudgetLineItem,
                              boolean isPrevBudget)

getNonPersonnelCalAmt

protected void getNonPersonnelCalAmt(Map<String,List<BudgetDecimal>> personnelBudgetLimits,
                         AwardBudgetLineItemExt awardBudgetLineItem,
                         boolean isPrevBudget)