org.kuali.kra.award.budget

Interface AwardBudgetService

All Superinterfaces:

BudgetCommonService<Award>

All Known Implementing Classes:

AwardBudgetServiceImpl

public interface AwardBudgetService
extends BudgetCommonService<Award>

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkForOutstandingBudgets(BudgetParentDocument parentDoc) Checks for budgets that have not been posted, cancelled or rejected.
boolean	checkRateChange(Collection<BudgetRate> allPropRates, Award award) This method checks if Award rates changed, then display confirmation message on 'open' budget version.
void	copyLineItemsFromProposalPeriods(Collection rawValues, BudgetPeriod awardBudgetPeriod) Copies all line items from the BudgetPeriods included in rawValues into awardBudgetPeriod fixing dates and making sure personnel referenced are also added to the awardBudget.
List<BudgetPeriod>	findBudgetPeriodsFromLinkedProposal(String awardNumber) Gets all budget periods from proposals that are funding this award.
Award	getActiveOrNewestAward(String awardNumber) Returns the active award or if none exist, the newest non-cancelled award.
List<BudgetDocumentVersion>	getAllBudgetsForAward(AwardDocument awardDocument)
List<String>	getInactiveBudgetStatus() Return a list of the award budget status codes that are considered inactive, currently cancelled, rejected and do not post.
BudgetDecimal	getTotalCostLimit(AwardDocument awardDocument) Get the total cost limit from the award.
void	populateBudgetLimitSummary(BudgetLimitSummaryHelper limitSummary, AwardDocument awardDocument) Populates the passed in limit summary given the award document.
void	post(AwardBudgetDocument awardBudgetDocument)
void	processApproval(AwardBudgetDocument awardBudgetDocument)
void	processDisapproval(AwardBudgetDocument awardBudgetDocument)
void	processSubmision(AwardBudgetDocument awardBudgetDocument)
AwardBudgetDocument	rebudget(AwardDocument awardDocument, String documentDescription)
void	setBudgetLimits(AwardBudgetDocument awardBudgetDocument, AwardDocument parentDocument) Populates the budget limits from the award.
void	toggleStatus(AwardBudgetDocument awardBudgetDocument)

Methods inherited from interface org.kuali.kra.budget.core.BudgetCommonService

calculateBudgetOnSave, copyBudgetVersion, copyBudgetVersion, getNewBudgetVersion, isRateOverridden, isRateOverridden, populateSummaryCalcAmounts, recalculateBudget, recalculateBudgetPeriod, removeBudgetSummaryPeriodCalcAmounts, validateAddingNewBudget

Method Detail

processSubmision

void processSubmision(AwardBudgetDocument awardBudgetDocument)

processApproval

void processApproval(AwardBudgetDocument awardBudgetDocument)

processDisapproval

void processDisapproval(AwardBudgetDocument awardBudgetDocument)

post

void post(AwardBudgetDocument awardBudgetDocument)

toggleStatus

void toggleStatus(AwardBudgetDocument awardBudgetDocument)

rebudget

AwardBudgetDocument rebudget(AwardDocument awardDocument,
                           String documentDescription)
                             throws org.kuali.rice.kew.api.exception.WorkflowException

Throws:

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

copyLineItemsFromProposalPeriods

void copyLineItemsFromProposalPeriods(Collection rawValues,
                                    BudgetPeriod awardBudgetPeriod)
                                      throws org.kuali.rice.kew.api.exception.WorkflowException

Copies all line items from the BudgetPeriods included in rawValues into awardBudgetPeriod fixing dates and making sure personnel referenced are also added to the awardBudget.

Parameters:

rawValues - Collection of BudgetPeriods with line items to be copied to the awardBudgetPeriod

awardBudgetPeriod -

Throws:

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

findBudgetPeriodsFromLinkedProposal

List<BudgetPeriod> findBudgetPeriodsFromLinkedProposal(String awardNumber)

Gets all budget periods from proposals that are funding this award.

Parameters:

awardNumber -

Returns:

getInactiveBudgetStatus

List<String> getInactiveBudgetStatus()

Return a list of the award budget status codes that are considered inactive, currently cancelled, rejected and do not post. This is used to determine which budgets to display by default.

Returns:

populateBudgetLimitSummary

void populateBudgetLimitSummary(BudgetLimitSummaryHelper limitSummary,
                              AwardDocument awardDocument)

Populates the passed in limit summary given the award document. Will not overwrite or recalculate previously stored budgets in the summary if they are the same budget as in the award document.

Parameters:

limitSummary -

awardDocument -

getAllBudgetsForAward

List<BudgetDocumentVersion> getAllBudgetsForAward(AwardDocument awardDocument)

getTotalCostLimit

BudgetDecimal getTotalCostLimit(AwardDocument awardDocument)

Get the total cost limit from the award. Returns the less of the obligated distributable amount or the total cost limit.

Parameters:

awardDocument -

Returns:

setBudgetLimits

void setBudgetLimits(AwardBudgetDocument awardBudgetDocument,
                   AwardDocument parentDocument)

Populates the budget limits from the award. This includes total cost limit and specific budget limits (direct and F&A currently)

Parameters:

awardBudgetDocument -

parentDocument -

getActiveOrNewestAward

Award getActiveOrNewestAward(String awardNumber)

Returns the active award or if none exist, the newest non-cancelled award.

Parameters:

awardNumber -

Returns:

checkForOutstandingBudgets

boolean checkForOutstandingBudgets(BudgetParentDocument parentDoc)

Checks for budgets that have not been posted, cancelled or rejected.

Parameters:

event -

award -

Returns:

true if any unfinalized budgets are found

Throws:

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

checkRateChange

boolean checkRateChange(Collection<BudgetRate> allPropRates,
                      Award award)

This method checks if Award rates changed, then display confirmation message on 'open' budget version.

Parameters:

saved - award budget rates

Award - award

Returns: