org.kuali.kra.budget.calculator

Interface BudgetCalculationService

All Known Subinterfaces:

AwardBudgetCalculationService

All Known Implementing Classes:

AwardBudgetCalculationServiceImpl, BudgetCalculationServiceImpl

public interface BudgetCalculationService

This class is for serving all calculations for a proposal budget.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyToLaterPeriods(Budget budget, BudgetPeriod budgetPeriod, BudgetLineItem budgetLineItem) This method is to apply budgetlineitem details to all later periods
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 budgetPersonnelDetails) 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
void	calculateSalary(Budget budget, BudgetPersonnelDetails budgetPersnnelLineItem) This method...
BudgetForm	getBudgetFormFromGlobalVariables()
List<Map<String,List<BudgetDecimal>>>	getBudgetLimitsTotals(String budgetId)
void	populateCalculatedAmount(Budget budget, BudgetLineItem budgetLineItem) This method is for calculating calculated amounts for each cost element.
void	populateCalculatedAmount(Budget budget, BudgetPersonnelDetails newBudgetPersonnelDetails) This method is for calculating calculated amounts for each cost element.
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.
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.

Method Detail

calculateBudget

void calculateBudget(Budget budget)

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

Parameters:

proposalNumber -

budgetVersionNumber -

calculateBudgetPeriod

void calculateBudgetPeriod(Budget budget,
                         BudgetPeriod budgetPeriod)

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

Parameters:

proposalNumber -

budgetVersionNumber -

calculateBudgetLineItem

void calculateBudgetLineItem(Budget budget,
                           BudgetPersonnelDetails budgetPersonnelDetails)

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)

Parameters:

budgetLineItem -

Throws:

BudgetException

calculateBudgetLineItem

void calculateBudgetLineItem(Budget budget,
                           BudgetLineItem budgetLineItem)

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)

Parameters:

budgetLineItem -

Throws:

BudgetException

populateCalculatedAmount

void populateCalculatedAmount(Budget budget,
                            BudgetLineItem budgetLineItem)

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.

Parameters:

budgetLineItem -

Throws:

BudgetException

rePopulateCalculatedAmount

void rePopulateCalculatedAmount(Budget budget,
                              BudgetLineItem budgetLineItem)

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.

Parameters:

budgetLineItem -

Throws:

BudgetException

calculateSalary

void calculateSalary(Budget budget,
                   BudgetPersonnelDetails budgetPersnnelLineItem)

This method...

Parameters:

budgetPersnnelLineItem -

Throws:

BudgetException

calculateBudgetTotals

void calculateBudgetTotals(Budget budget)

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

Parameters:

budget -

calculateBudgetSummaryTotals

void calculateBudgetSummaryTotals(Budget budget)

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

Parameters:

budget -

applyToLaterPeriods

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

This method is to apply budgetlineitem details to all later periods

Parameters:

budget -

budgetPeriod -

budgetLineItem -

syncToPeriodCostLimit

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

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

Parameters:

budget -

budgetPeriod -

budgetLineItem -

populateCalculatedAmount

void populateCalculatedAmount(Budget budget,
                            BudgetPersonnelDetails newBudgetPersonnelDetails)

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.

Parameters:

budgetLineItem -

Throws:

BudgetException

rePopulateCalculatedAmount

void rePopulateCalculatedAmount(Budget budget,
                              BudgetPersonnelDetails newBudgetPersonnelDetails)

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.

Parameters:

budgetLineItem -

Throws:

BudgetException

updatePersonnelBudgetRate

void updatePersonnelBudgetRate(BudgetLineItem budgetLineItem)

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

Parameters:

budgetLineItem - BudgetLineItem instance to examine amounts for synchronization

syncToPeriodDirectCostLimit

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

Parameters:

budget -

budgetPeriod -

budgetLineItem -

getBudgetFormFromGlobalVariables

BudgetForm getBudgetFormFromGlobalVariables()

getBudgetLimitsTotals

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