org.kuali.kra.award.budget

Class AwardBudgetServiceImpl

java.lang.Object

org.kuali.kra.award.budget.AwardBudgetServiceImpl

All Implemented Interfaces:

AwardBudgetService, BudgetCommonService<Award>

public class AwardBudgetServiceImpl
extends Object
implements AwardBudgetService

This class is to process all basic services required for AwardBudget

Constructor Summary

Constructors

Constructor and Description
AwardBudgetServiceImpl()

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
boolean	checkForOutstandingBudgets(BudgetParentDocument parentDoc) Checks for budgets that have not been posted, cancelled or rejected.
boolean	checkRateChange(Collection<BudgetRate> savedBudgetRates, Award award) This method checks if Award rates changed, then display confirmation message on 'open' budget version.
BudgetDocument<Award>	copyBudgetVersion(BudgetDocument<Award> budgetDocument) Copies budget version from previous one
BudgetDocument<Award>	copyBudgetVersion(BudgetDocument<Award> budgetDocument, boolean onlyOnePeriod)
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.
protected void	copyObligatedAmountToLineItems(AwardBudgetDocument awardBudgetDocument, BudgetDecimal obligatedChangeAmount)
protected AwardBudgetDocument	copyPostedBudgetVersion(AwardDocument parentDocument)
protected void	copyProposalBudgetLineItemsToAwardBudget(BudgetPeriod awardBudgetPeriod, BudgetPeriod proposalBudgetPeriod)
protected AwardBudgetDocument	createNewBudgetDocument(String documentDescription, AwardDocument parentDocument, boolean rebudget) This method...
List<BudgetPeriod>	findBudgetPeriodsFromLinkedProposal(String awardNumber) Gets all budget periods from proposals that are funding this award.
protected BudgetPerson	findMatchingPersonInBudget(Budget budget, BudgetPerson oldBudgetPerson, String jobCode)
protected List	findObjectsWithSingleKey(Class clazz, String key, Object value) Use the business object service to match the criteria passed in
protected String	findStatusDescription(String statusCode)
Award	getActiveOrNewestAward(String awardNumber) Returns the active award or if none exist, the newest non-cancelled award.
List<BudgetDocumentVersion>	getAllBudgetsForAward(AwardDocument awardDocument)
protected AwardBudgetCalculationService	getAwardBudgetCalculationService()
protected String	getAwardPostedStatusCode()
protected AwardService	getAwardService()
protected BudgetCalculationService	getBudgetCalculationService()
BudgetService<Award>	getBudgetService() Gets the budgetService attribute.
BudgetSummaryService	getBudgetSummaryService() Gets the budgetSummaryService attribute.
org.kuali.rice.krad.service.BusinessObjectService	getBusinessObjectService() Gets the businessObjectService attribute.
protected String	getCancelledBudgetStatus()
protected AwardBudgetExt	getCurrentBudget(AwardDocument awardDocument) Returns the current budget for the award.
protected DeepCopyPostProcessor	getDeepCopyPostProcessor()
protected String	getDisapprovedBudgetStatus()
org.kuali.rice.krad.service.DocumentService	getDocumentService() Gets the documentService attribute.
protected String	getDoNotPostBudgetStatus()
List<String>	getInactiveBudgetStatus() Return a list of the award budget status codes that are considered inactive, currently cancelled, rejected and do not post.
protected BudgetVersionOverview	getLastBudgetVersion(AwardDocument award)
protected AwardBudgetExt	getLatestPostedBudget(AwardDocument awardDocument)
BudgetDocument<Award>	getNewBudgetVersion(BudgetParentDocument<Award> parentBudgetDocument, String documentDescription) Returns a new finalized BudgetDocument based on the given ProposalDevelopmentDocument and documentDescription.
protected AwardBudgetExt	getNewestBudgetByStatus(AwardDocument awardDocument, List<String> statuses)
org.kuali.rice.coreservice.framework.parameter.ParameterService	getParameterService() Gets the parameterService attribute.
protected String	getParameterValue(String awardBudgetParameter)
protected String	getPostedBudgetStatus()
protected BudgetDecimal	getPostedTotalAmount(AwardDocument awardDocument) Gets the total posted amount from previously posted budgets
protected AwardBudgetExt	getPreviousBudget(AwardDocument awardDocument) Returns the previous budget for this award document which will be the newest posted budget
protected String	getRejectedBudgetStatus()
BudgetDecimal	getTotalCostLimit(AwardDocument awardDocument) Get the total cost limit from the award.
protected VersionHistoryService	getVersionHistoryService()
protected org.kuali.rice.kew.api.WorkflowDocument	getWorkflowDocument(org.kuali.rice.krad.document.Document doc) Get the corresponding workflow document.
protected boolean	isPostedBudgetExist(AwardDocument awardDocument)
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	populateBudgetLimitSummary(BudgetLimitSummaryHelper summary, AwardDocument awardDocument) Populates the passed in limit summary given the award document.
void	populateSummaryCalcAmounts(Budget budget, BudgetPeriod budgetPeriod)
void	post(AwardBudgetDocument awardBudgetDocument)
void	processApproval(AwardBudgetDocument awardBudgetDocument)
void	processDisapproval(AwardBudgetDocument awardBudgetDocument)
protected void	processStatusChange(AwardBudgetDocument awardBudgetDocument, String routingStatus)
void	processSubmision(AwardBudgetDocument awardBudgetDocument)
AwardBudgetDocument	rebudget(AwardDocument awardDocument, String documentDescription)
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
protected void	saveBudgetDocument(BudgetDocument<Award> budgetDocument, boolean rebudget) This method...
protected void	saveDocument(AwardBudgetDocument awardBudgetDocument) This method...
void	setAwardBudgetCalculationService(AwardBudgetCalculationService awardBudgetCalculationService)
void	setAwardService(AwardService awardService)
void	setBudgetCalculationService(BudgetCalculationService budgetCalculationService)
protected void	setBudgetCostsFromPeriods(Budget budget) This method sets the budget document's costs from the budget periods' costs.
void	setBudgetLimits(AwardBudgetDocument awardBudgetDocument, AwardDocument parentDocument) Populates the budget limits from the award.
void	setBudgetService(BudgetService<Award> budgetService) Sets the budgetService attribute value.
void	setBudgetSummaryService(BudgetSummaryService budgetSummaryService) Sets the budgetSummaryService attribute value.
void	setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService) Sets the businessObjectService attribute value.
void	setDocumentService(org.kuali.rice.krad.service.DocumentService documentservice) Sets the documentService attribute value.
void	setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService) Sets the parameterService attribute value.
void	setVersionHistoryService(VersionHistoryService versionHistoryService)
void	toggleStatus(AwardBudgetDocument awardBudgetDocument)
boolean	validateAddingNewBudget(BudgetParentDocument<Award> parentDocument) Make sure its ok to add a new budget version.

Methods inherited from class java.lang.Object

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

Constructor Detail

AwardBudgetServiceImpl

public AwardBudgetServiceImpl()

Method Detail

post

public void post(AwardBudgetDocument awardBudgetDocument)

Specified by:

post in interface AwardBudgetService

See Also:

AwardBudgetService.post(org.kuali.kra.award.budget.document.AwardBudgetDocument)

toggleStatus

public void toggleStatus(AwardBudgetDocument awardBudgetDocument)

Specified by:

toggleStatus in interface AwardBudgetService

See Also:

AwardBudgetService.post(org.kuali.kra.award.budget.document.AwardBudgetDocument)

saveDocument

protected void saveDocument(AwardBudgetDocument awardBudgetDocument)

This method...

Parameters:

awardBudgetDocument -

processApproval

public void processApproval(AwardBudgetDocument awardBudgetDocument)

Specified by:

processApproval in interface AwardBudgetService

See Also:

AwardBudgetService.processApproval(org.kuali.kra.award.budget.document.AwardBudgetDocument)

processDisapproval

public void processDisapproval(AwardBudgetDocument awardBudgetDocument)

Specified by:

processDisapproval in interface AwardBudgetService

See Also:

AwardBudgetService.processDisapproval(org.kuali.kra.award.budget.document.AwardBudgetDocument)

processSubmision

public void processSubmision(AwardBudgetDocument awardBudgetDocument)

Specified by:

processSubmision in interface AwardBudgetService

See Also:

AwardBudgetService.processSubmision(org.kuali.kra.award.budget.document.AwardBudgetDocument)

processStatusChange

protected void processStatusChange(AwardBudgetDocument awardBudgetDocument,
                       String routingStatus)

getParameterValue

protected String getParameterValue(String awardBudgetParameter)

findStatusDescription

protected String findStatusDescription(String statusCode)

rebudget

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

Specified by:

rebudget in interface AwardBudgetService

Throws:

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

See Also:

org.kuali.kra.award.budget.AwardBudgetService#rebudget(org.kuali.kra.award.budget.document.AwardBudgetDocument)

getWorkflowDocument

protected org.kuali.rice.kew.api.WorkflowDocument getWorkflowDocument(org.kuali.rice.krad.document.Document doc)

Get the corresponding workflow document.

Parameters:

doc - the document

Returns:

the workflow document or null if there is none

getParameterService

public org.kuali.rice.coreservice.framework.parameter.ParameterService getParameterService()

Gets the parameterService attribute.

Returns:

Returns the parameterService.

setParameterService

public void setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService)

Sets the parameterService attribute value.

Parameters:

parameterService - The parameterService to set.

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.

getDocumentService

public org.kuali.rice.krad.service.DocumentService getDocumentService()

Gets the documentService attribute.

Returns:

Returns the documentService.

setDocumentService

public void setDocumentService(org.kuali.rice.krad.service.DocumentService documentservice)

Sets the documentService attribute value.

Parameters:

documentService - The documentService to set.

getNewBudgetVersion

public BudgetDocument<Award> getNewBudgetVersion(BudgetParentDocument<Award> parentBudgetDocument,
                                        String documentDescription)
                                          throws org.kuali.rice.kew.api.exception.WorkflowException

Description copied from interface: BudgetCommonService

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

Specified by:

getNewBudgetVersion in interface BudgetCommonService<Award>

Returns:

BudgetDocument

Throws:

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

See Also:

BudgetCommonService.getNewBudgetVersion(org.kuali.kra.budget.document.BudgetParentDocument, java.lang.String)

copyPostedBudgetVersion

protected AwardBudgetDocument copyPostedBudgetVersion(AwardDocument parentDocument)

createNewBudgetDocument

protected AwardBudgetDocument createNewBudgetDocument(String documentDescription,
                                          AwardDocument parentDocument,
                                          boolean rebudget)
                                               throws org.kuali.rice.kew.api.exception.WorkflowException

This method...

Parameters:

documentDescription -

parentDocument -

Returns:

Throws:

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

setBudgetLimits

public void setBudgetLimits(AwardBudgetDocument awardBudgetDocument,
                   AwardDocument parentDocument)

Description copied from interface: AwardBudgetService

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

Specified by:

setBudgetLimits in interface AwardBudgetService

copyObligatedAmountToLineItems

protected void copyObligatedAmountToLineItems(AwardBudgetDocument awardBudgetDocument,
                                  BudgetDecimal obligatedChangeAmount)

getLatestPostedBudget

protected AwardBudgetExt getLatestPostedBudget(AwardDocument awardDocument)

getTotalCostLimit

public BudgetDecimal getTotalCostLimit(AwardDocument awardDocument)

Description copied from interface: AwardBudgetService

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

Specified by:

getTotalCostLimit in interface AwardBudgetService

Returns:

See Also:

AwardBudgetService.getTotalCostLimit(org.kuali.kra.award.document.AwardDocument)

getPostedTotalAmount

protected BudgetDecimal getPostedTotalAmount(AwardDocument awardDocument)

Gets the total posted amount from previously posted budgets

Parameters:

awardDocument -

Returns:

isPostedBudgetExist

protected boolean isPostedBudgetExist(AwardDocument awardDocument)

getAwardPostedStatusCode

protected String getAwardPostedStatusCode()

getLastBudgetVersion

protected BudgetVersionOverview getLastBudgetVersion(AwardDocument award)

saveBudgetDocument

protected void saveBudgetDocument(BudgetDocument<Award> budgetDocument,
                      boolean rebudget)
                           throws org.kuali.rice.kew.api.exception.WorkflowException

This method...

Parameters:

budgetDocument -

isProposalBudget -

budget -

budgetParent -

Throws:

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

copyProposalBudgetLineItemsToAwardBudget

protected void copyProposalBudgetLineItemsToAwardBudget(BudgetPeriod awardBudgetPeriod,
                                            BudgetPeriod proposalBudgetPeriod)

findMatchingPersonInBudget

protected BudgetPerson findMatchingPersonInBudget(Budget budget,
                                      BudgetPerson oldBudgetPerson,
                                      String jobCode)

getDeepCopyPostProcessor

protected DeepCopyPostProcessor getDeepCopyPostProcessor()

copyBudgetVersion

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

Copies budget version from previous one

Specified by:

copyBudgetVersion in interface BudgetCommonService<Award>

Returns:

BudgetDocument

Throws:

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

See Also:

BudgetCommonService.copyBudgetVersion(org.kuali.kra.budget.document.BudgetDocument)

copyBudgetVersion

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

Specified by:

copyBudgetVersion in interface BudgetCommonService<Award>

Throws:

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

setBudgetService

public void setBudgetService(BudgetService<Award> budgetService)

Sets the budgetService attribute value.

Parameters:

budgetService - The budgetService to set.

getBudgetService

public BudgetService<Award> getBudgetService()

Gets the budgetService attribute.

Returns:

Returns the budgetService.

getBudgetSummaryService

public BudgetSummaryService getBudgetSummaryService()

Gets the budgetSummaryService attribute.

Returns:

Returns the budgetSummaryService.

setBudgetSummaryService

public void setBudgetSummaryService(BudgetSummaryService budgetSummaryService)

Sets the budgetSummaryService attribute value.

Parameters:

budgetSummaryService - The budgetSummaryService to set.

copyLineItemsFromProposalPeriods

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

Description copied from interface: AwardBudgetService

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.

Specified by:

copyLineItemsFromProposalPeriods in interface AwardBudgetService

Parameters:

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

Throws:

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

findObjectsWithSingleKey

protected List findObjectsWithSingleKey(Class clazz,
                            String key,
                            Object value)

Use the business object service to match the criteria passed in

Parameters:

clazz -

key -

value -

Returns:

findBudgetPeriodsFromLinkedProposal

public List<BudgetPeriod> findBudgetPeriodsFromLinkedProposal(String awardNumber)

Description copied from interface: AwardBudgetService

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

Specified by:

findBudgetPeriodsFromLinkedProposal in interface AwardBudgetService

Returns:

See Also:

AwardBudgetService.findBudgetPeriodsFromLinkedProposal(java.lang.String)

checkForOutstandingBudgets

public boolean checkForOutstandingBudgets(BudgetParentDocument parentDoc)

Description copied from interface: AwardBudgetService

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

Specified by:

checkForOutstandingBudgets in interface AwardBudgetService

Returns:

true if any unfinalized budgets are found

getInactiveBudgetStatus

public List<String> getInactiveBudgetStatus()

Description copied from interface: AwardBudgetService

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.

Specified by:

getInactiveBudgetStatus in interface AwardBudgetService

Returns:

See Also:

AwardBudgetService.getInactiveBudgetStatus()

populateBudgetLimitSummary

public void populateBudgetLimitSummary(BudgetLimitSummaryHelper summary,
                              AwardDocument awardDocument)

Description copied from interface: AwardBudgetService

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.

Specified by:

populateBudgetLimitSummary in interface AwardBudgetService

See Also:

AwardBudgetService.populateBudgetLimitSummary(org.kuali.kra.award.budget.BudgetLimitSummaryHelper, org.kuali.kra.award.document.AwardDocument)

getCurrentBudget

protected AwardBudgetExt getCurrentBudget(AwardDocument awardDocument)

Returns the current budget for the award. Must be inprogress, submitted or to be posted to be the current budget.

Parameters:

awardDocument -

Returns:

getPreviousBudget

protected AwardBudgetExt getPreviousBudget(AwardDocument awardDocument)

Returns the previous budget for this award document which will be the newest posted budget

Parameters:

awardDocument -

Returns:

getNewestBudgetByStatus

protected AwardBudgetExt getNewestBudgetByStatus(AwardDocument awardDocument,
                                     List<String> statuses)

getAllBudgetsForAward

public List<BudgetDocumentVersion> getAllBudgetsForAward(AwardDocument awardDocument)

Specified by:

getAllBudgetsForAward in interface AwardBudgetService

getActiveOrNewestAward

public Award getActiveOrNewestAward(String awardNumber)

Description copied from interface: AwardBudgetService

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

Specified by:

getActiveOrNewestAward in interface AwardBudgetService

Returns:

getPostedBudgetStatus

protected String getPostedBudgetStatus()

getRejectedBudgetStatus

protected String getRejectedBudgetStatus()

getCancelledBudgetStatus

protected String getCancelledBudgetStatus()

getDisapprovedBudgetStatus

protected String getDisapprovedBudgetStatus()

getDoNotPostBudgetStatus

protected String getDoNotPostBudgetStatus()

getVersionHistoryService

protected VersionHistoryService getVersionHistoryService()

setVersionHistoryService

public void setVersionHistoryService(VersionHistoryService versionHistoryService)

getAwardBudgetCalculationService

protected AwardBudgetCalculationService getAwardBudgetCalculationService()

setAwardBudgetCalculationService

public void setAwardBudgetCalculationService(AwardBudgetCalculationService awardBudgetCalculationService)

getBudgetCalculationService

protected BudgetCalculationService getBudgetCalculationService()

setBudgetCalculationService

public void setBudgetCalculationService(BudgetCalculationService budgetCalculationService)

isRateOverridden

public boolean isRateOverridden(BudgetPeriod budgetPeriod)

Description copied from interface: BudgetCommonService

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

Specified by:

isRateOverridden in interface BudgetCommonService<Award>

Returns:

true if there is any change

recalculateBudget

public void recalculateBudget(Budget budget)

Description copied from interface: BudgetCommonService

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

Specified by:

recalculateBudget in interface BudgetCommonService<Award>

recalculateBudgetPeriod

public void recalculateBudgetPeriod(Budget budget,
                           BudgetPeriod budgetPeriod)

Specified by:

recalculateBudgetPeriod in interface BudgetCommonService<Award>

calculateBudgetOnSave

public void calculateBudgetOnSave(Budget budget)

Description copied from interface: BudgetCommonService

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

Specified by:

calculateBudgetOnSave in interface BudgetCommonService<Award>

populateSummaryCalcAmounts

public void populateSummaryCalcAmounts(Budget budget,
                              BudgetPeriod budgetPeriod)

Specified by:

populateSummaryCalcAmounts in interface BudgetCommonService<Award>

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.

isRateOverridden

public boolean isRateOverridden(Budget budget)

Description copied from interface: BudgetCommonService

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

Specified by:

isRateOverridden in interface BudgetCommonService<Award>

Returns:

true if there is any change

removeBudgetSummaryPeriodCalcAmounts

public void removeBudgetSummaryPeriodCalcAmounts(BudgetPeriod budgetPeriod)

Description copied from interface: BudgetCommonService

This method will clear the BudgetSumamryPeriodCalcAmounts

Specified by:

removeBudgetSummaryPeriodCalcAmounts in interface BudgetCommonService<Award>

validateAddingNewBudget

public boolean validateAddingNewBudget(BudgetParentDocument<Award> parentDocument)

Description copied from interface: BudgetCommonService

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.

Specified by:

validateAddingNewBudget in interface BudgetCommonService<Award>

Returns:

true if ok to add new budget, false otherwise

See Also:

BudgetCommonService.validateAddingNewBudget(org.kuali.kra.budget.document.BudgetParentDocument)

checkRateChange

public boolean checkRateChange(Collection<BudgetRate> savedBudgetRates,
                      Award award)

Description copied from interface: AwardBudgetService

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

Specified by:

checkRateChange in interface AwardBudgetService

Returns:

getAwardService

protected AwardService getAwardService()

setAwardService

public void setAwardService(AwardService awardService)