org.kuali.kra.s2s.service

Interface S2SBudgetCalculatorService

All Known Implementing Classes:

S2SBudgetCalculatorServiceImpl

public interface S2SBudgetCalculatorService

This class contains the Budget related calculations for a proposal

Author:

Kuali Research Administration Team (kualidev@oncourse.iu.edu)

Method Summary

Methods

Modifier and Type	Method and Description
List<BudgetCategoryMap>	getBudgetCategoryMapList(List<String> filterTargetCategoryCodes, List<String> filterCategoryTypes) This method returns a list of BudgetCategoryMap based on the input.
BudgetSummaryInfo	getBudgetInfo(ProposalDevelopmentDocument pdDoc, List<BudgetPeriodInfo> budgetperiodList) This method does the budget related calculations for a given ProposalDevelopmentDocument and returns them in BudgetSummaryInfo
List<BudgetPeriodInfo>	getBudgetPeriods(ProposalDevelopmentDocument pdDoc) This method gets the list of BudgetPeriodInfo for the latest BudgetDocument of the given ProposalDevelopmentDocument
BudgetDocument	getFinalBudgetVersion(ProposalDevelopmentDocument pdDoc) This method returns the final version of BudgetDocument for a given ProposalDevelopmentDocument
IndirectCostInfo	getIndirectCosts(Budget budget, BudgetPeriod budgetPeriod) This method computes the indirect costs for a given BudgetPeriod
BudgetDecimal	getProposalPersonSalary(ProposalDevelopmentDocument pdDoc, ProposalPerson proposalPerson) This method gets the salary requested for a given proposal person.
boolean	isPersonNonMITPerson(ProposalPerson proposalPerson) This method determines whether a ProposalPerson is a Non MIT person

Method Detail

getBudgetCategoryMapList

List<BudgetCategoryMap> getBudgetCategoryMapList(List<String> filterTargetCategoryCodes,
                                               List<String> filterCategoryTypes)

This method returns a list of BudgetCategoryMap based on the input. The list returned will not contain the categories that the codes passed as a list of String and also will not contain those that match the types passed as list of String. In case 2 empty lists are passed as parameters, the method will return entire list without applying any filters.

Parameters:

filterTargetCategoryCodes - Category Codes that must be filtered

filterCategoryTypes - Category types that must be filtered

Returns:

a List of BudgetCategoryMap.

getBudgetInfo

BudgetSummaryInfo getBudgetInfo(ProposalDevelopmentDocument pdDoc,
                              List<BudgetPeriodInfo> budgetperiodList)
                                throws S2SException

This method does the budget related calculations for a given ProposalDevelopmentDocument and returns them in BudgetSummaryInfo

Parameters:

pdDoc - ProposalDevelopmentDocument.

Returns:

BudgetSummaryInfo corresponding to the ProposalDevelopmentDocument object.

Throws:

S2SException

getBudgetPeriods

List<BudgetPeriodInfo> getBudgetPeriods(ProposalDevelopmentDocument pdDoc)
                                        throws S2SException

This method gets the list of BudgetPeriodInfo for the latest BudgetDocument of the given ProposalDevelopmentDocument

Parameters:

pdDoc - ProposalDevelopmentDocument

Returns:

a List of BudgetPeriodInfo corresponding to the ProposalDevelopmentDocument object.

Throws:

S2SException

getFinalBudgetVersion

BudgetDocument getFinalBudgetVersion(ProposalDevelopmentDocument pdDoc)
                                     throws S2SException

This method returns the final version of BudgetDocument for a given ProposalDevelopmentDocument

Parameters:

pdDoc - Proposal development document.

Returns:

BudgetDocument final version of budget corresponding to the ProposalDevelopmentDocument object.

Throws:

S2SException

getProposalPersonSalary

BudgetDecimal getProposalPersonSalary(ProposalDevelopmentDocument pdDoc,
                                    ProposalPerson proposalPerson)
                                      throws S2SException

This method gets the salary requested for a given proposal person.

Parameters:

pdDoc - ProposalDevelopmentDocument from which salary needs to be fetched

proposalPerson - proposal person whose salary needs to be fetched

Returns:

BudgetDecimal salary of proposal person

Throws:

S2SException

isPersonNonMITPerson

boolean isPersonNonMITPerson(ProposalPerson proposalPerson)

This method determines whether a ProposalPerson is a Non MIT person

Parameters:

proposalPerson - ProposalPerson.

Returns:

boolean true if Non MIT Person false otherwise.

getIndirectCosts

IndirectCostInfo getIndirectCosts(Budget budget,
                                BudgetPeriod budgetPeriod)

This method computes the indirect costs for a given BudgetPeriod

Parameters:

budgetPeriod - given BudgetPeriod.

Returns:

IndirectCostInfo for the corresponding BudgetPeriod object.