org.kuali.kra.budget.core

Interface BudgetCommonService<T extends BudgetParent>

All Known Subinterfaces:

AwardBudgetService, ProposalBudgetService

All Known Implementing Classes:

AwardBudgetServiceImpl, ProposalBudgetServiceImpl

public interface BudgetCommonService<T extends BudgetParent>

This interface has services which required different implementations in AwardBudget and ProposalBudget modules

Method Summary

Methods

Modifier and Type	Method and Description
void	calculateBudgetOnSave(Budget budget) This method will take care of summing up all line item costs or summary line items to Period totals
BudgetDocument<T>	copyBudgetVersion(BudgetDocument<T> budgetDocument) Returns a new finalized BudgetDocument with the data from the given BudgetDocument copied over.
BudgetDocument<T>	copyBudgetVersion(BudgetDocument<T> budgetDocument, boolean onlyOnePeriod)
BudgetDocument<T>	getNewBudgetVersion(BudgetParentDocument<T> parentDocument, String documentDescription) Returns a new finalized BudgetDocument based on the given ProposalDevelopmentDocument and documentDescription.
boolean	isRateOverridden(Budget budget) This method is to check whether Budget Summary calculated amounts have been modified on AwardBudgetSummary screen
boolean	isRateOverridden(BudgetPeriod budgetPeriod) This method is to check whether Budget Summary calculated amounts for a BudgetPeriod have been modified on AwardBudgetSummary screen
void	populateSummaryCalcAmounts(Budget budget, BudgetPeriod budgetPeriod)
void	recalculateBudget(Budget budget) This method is recalculate the budget.
void	recalculateBudgetPeriod(Budget budget, BudgetPeriod budgetPeriod)
void	removeBudgetSummaryPeriodCalcAmounts(BudgetPeriod budgetPeriod) This method will clear the BudgetSumamryPeriodCalcAmounts
boolean	validateAddingNewBudget(BudgetParentDocument<T> parentDocument) Make sure its ok to add a new budget version.

Method Detail

getNewBudgetVersion

BudgetDocument<T> getNewBudgetVersion(BudgetParentDocument<T> parentDocument,
                                    String documentDescription)
                                                           throws org.kuali.rice.kew.api.exception.WorkflowException

Returns a new finalized BudgetDocument based on the given ProposalDevelopmentDocument and documentDescription.

Parameters:

pdDoc -

documentDescription -

Returns:

BudgetDocument

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

copyBudgetVersion

BudgetDocument<T> copyBudgetVersion(BudgetDocument<T> budgetDocument)
                                                         throws org.kuali.rice.kew.api.exception.WorkflowException

Returns a new finalized BudgetDocument with the data from the given BudgetDocument copied over.

Parameters:

budgetDocument -

Returns:

BudgetDocument

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

copyBudgetVersion

BudgetDocument<T> copyBudgetVersion(BudgetDocument<T> budgetDocument,
                                  boolean onlyOnePeriod)
                                                         throws org.kuali.rice.kew.api.exception.WorkflowException

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

isRateOverridden

boolean isRateOverridden(BudgetPeriod budgetPeriod)

This method is to check whether Budget Summary calculated amounts for a BudgetPeriod have been modified on AwardBudgetSummary screen

Parameters:

budgetPeriod -

Returns:

true if there is any change

recalculateBudget

void recalculateBudget(Budget budget)

This method is recalculate the budget. For Proposal Budget, recalcuate is same as calculate. For Award Budget, it removes Award Budget Sumamry Calc Amounts before the calculation

Parameters:

budget -

calculateBudgetOnSave

void calculateBudgetOnSave(Budget budget)

This method will take care of summing up all line item costs or summary line items to Period totals

Parameters:

budget -

isRateOverridden

boolean isRateOverridden(Budget budget)

This method is to check whether Budget Summary calculated amounts have been modified on AwardBudgetSummary screen

Parameters:

budget -

Returns:

true if there is any change

removeBudgetSummaryPeriodCalcAmounts

void removeBudgetSummaryPeriodCalcAmounts(BudgetPeriod budgetPeriod)

This method will clear the BudgetSumamryPeriodCalcAmounts

Parameters:

budgetPeriod -

populateSummaryCalcAmounts

void populateSummaryCalcAmounts(Budget budget,
                              BudgetPeriod budgetPeriod)

validateAddingNewBudget

boolean validateAddingNewBudget(BudgetParentDocument<T> parentDocument)

Make sure its ok to add a new budget version. This is primarily used for the award budgets as the other budgets status affects whether a new budget may be created. This method should add error messages as to why the budget may not be created.

Parameters:

parentDocument -

Returns:

true if ok to add new budget, false otherwise

recalculateBudgetPeriod

void recalculateBudgetPeriod(Budget budget,
                           BudgetPeriod budgetPeriod)