org.kuali.kra.proposaldevelopment.budget.service.impl

Class ProposalBudgetServiceImpl

java.lang.Object

org.kuali.kra.proposaldevelopment.budget.service.impl.ProposalBudgetServiceImpl

All Implemented Interfaces:

BudgetCommonService<DevelopmentProposal>, ProposalBudgetService

public class ProposalBudgetServiceImpl
extends Object
implements ProposalBudgetService

This class process requests for ProposalBudget

Constructor Summary

Constructors

Constructor and Description
ProposalBudgetServiceImpl()

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<DevelopmentProposal>	copyBudgetVersion(BudgetDocument<DevelopmentProposal> budgetDocument) Returns a new finalized BudgetDocument with the data from the given BudgetDocument copied over.
BudgetDocument<DevelopmentProposal>	copyBudgetVersion(BudgetDocument<DevelopmentProposal> budgetDocument, boolean onlyOnePeriod)
BudgetCalculationService	getBudgetCalculationService() Gets the budgetCalculationService attribute.
BudgetService<DevelopmentProposal>	getBudgetService() Gets the budgetService attribute.
protected BudgetSubAwardService	getBudgetSubAwardService()
org.kuali.rice.krad.service.DocumentService	getDocumentService() Gets the documentService attribute.
BudgetDocument<DevelopmentProposal>	getNewBudgetVersion(BudgetParentDocument<DevelopmentProposal> parentDocument, String documentDescription) Returns a new finalized BudgetDocument based on the given ProposalDevelopmentDocument and documentDescription.
org.kuali.rice.coreservice.framework.parameter.ParameterService	getParameterService() Gets the parameterService attribute.
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) Do nothing for proposal budget
protected void	saveBudgetDocument(BudgetDocument<DevelopmentProposal> budgetDocument) This method...
void	setBudgetCalculationService(BudgetCalculationService budgetCalculationService) Sets the budgetCalculationService attribute value.
void	setBudgetService(BudgetService<DevelopmentProposal> budgetService) Sets the budgetService attribute value.
void	setBudgetSubAwardService(BudgetSubAwardService budgetSubAwardService)
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.
boolean	validateAddingNewBudget(BudgetParentDocument<DevelopmentProposal> 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

ProposalBudgetServiceImpl

public ProposalBudgetServiceImpl()

Method Detail

getNewBudgetVersion

public BudgetDocument<DevelopmentProposal> getNewBudgetVersion(BudgetParentDocument<DevelopmentProposal> parentDocument,
                                                      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<DevelopmentProposal>

Returns:

BudgetDocument

Throws:

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

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<DevelopmentProposal>

Returns:

true if there is any change

saveBudgetDocument

protected void saveBudgetDocument(BudgetDocument<DevelopmentProposal> budgetDocument)
                           throws org.kuali.rice.kew.api.exception.WorkflowException

This method...

Parameters:

budgetDocument -

isProposalBudget -

budget -

budgetParent -

Throws:

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

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.

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.

copyBudgetVersion

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

Description copied from interface: BudgetCommonService

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

Specified by:

copyBudgetVersion in interface BudgetCommonService<DevelopmentProposal>

Returns:

BudgetDocument

Throws:

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

copyBudgetVersion

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

Specified by:

copyBudgetVersion in interface BudgetCommonService<DevelopmentProposal>

Throws:

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

setBudgetService

public void setBudgetService(BudgetService<DevelopmentProposal> budgetService)

Sets the budgetService attribute value.

Parameters:

budgetService - The budgetService to set.

getBudgetService

public BudgetService<DevelopmentProposal> getBudgetService()

Gets the budgetService attribute.

Returns:

Returns the budgetService.

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<DevelopmentProposal>

setBudgetCalculationService

public void setBudgetCalculationService(BudgetCalculationService budgetCalculationService)

Sets the budgetCalculationService attribute value.

Parameters:

budgetCalculationService - The budgetCalculationService to set.

getBudgetCalculationService

public BudgetCalculationService getBudgetCalculationService()

Gets the budgetCalculationService attribute.

Returns:

Returns the budgetCalculationService.

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<DevelopmentProposal>

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<DevelopmentProposal>

Returns:

true if there is any change

removeBudgetSummaryPeriodCalcAmounts

public void removeBudgetSummaryPeriodCalcAmounts(BudgetPeriod budgetPeriod)

Do nothing for proposal budget

Specified by:

removeBudgetSummaryPeriodCalcAmounts in interface BudgetCommonService<DevelopmentProposal>

See Also:

BudgetCommonService.removeBudgetSummaryPeriodCalcAmounts(org.kuali.kra.budget.parameters.BudgetPeriod)

populateSummaryCalcAmounts

public void populateSummaryCalcAmounts(Budget budget,
                              BudgetPeriod budgetPeriod)

Specified by:

populateSummaryCalcAmounts in interface BudgetCommonService<DevelopmentProposal>

validateAddingNewBudget

public boolean validateAddingNewBudget(BudgetParentDocument<DevelopmentProposal> 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<DevelopmentProposal>

Returns:

true if ok to add new budget, false otherwise

See Also:

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

recalculateBudgetPeriod

public void recalculateBudgetPeriod(Budget budget,
                           BudgetPeriod budgetPeriod)

Specified by:

recalculateBudgetPeriod in interface BudgetCommonService<DevelopmentProposal>

getBudgetSubAwardService

protected BudgetSubAwardService getBudgetSubAwardService()

setBudgetSubAwardService

public void setBudgetSubAwardService(BudgetSubAwardService budgetSubAwardService)