org.kuali.coeus.s2sgen.impl.budget

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
org.kuali.coeus.sys.api.model.ScaleTwoDecimal	getBaseSalaryByPeriod(Long budgetId, int budgetPeriod, KeyPersonDto keyPerson)
List<? extends org.kuali.coeus.common.budget.api.core.category.BudgetCategoryMapContract>	getBudgetCategoryMapList(List<String> filterTargetCategoryCodes, List<String> filterCategoryTypes) This method returns a list of BudgetCategoryMapContract based on the input.
BudgetSummaryDto	getBudgetInfo(org.kuali.coeus.propdev.api.core.ProposalDevelopmentDocumentContract pdDoc, List<BudgetPeriodDto> budgetperiodList) This method does the budget related calculations for a given ProposalDevelopmentDocumentContract and returns them in BudgetSummaryDto
List<BudgetPeriodDto>	getBudgetPeriods(org.kuali.coeus.propdev.api.core.ProposalDevelopmentDocumentContract pdDoc) This method gets the list of BudgetPeriodDto for the latest BudgetContract of the given ProposalDevelopmentDocumentContract
IndirectCostDto	getIndirectCosts(org.kuali.coeus.common.budget.api.core.BudgetContract budget, org.kuali.coeus.common.budget.api.period.BudgetPeriodContract budgetPeriod) This method computes the indirect costs for a given BudgetPeriodContract
List<? extends org.kuali.coeus.common.budget.api.nonpersonnel.BudgetLineItemContract>	getMatchingLineItems(List<? extends org.kuali.coeus.common.budget.api.nonpersonnel.BudgetLineItemContract> lineItems, List<String> budgetCategoryType)
String	getParticipantSupportCategoryCode()
boolean	isPersonNonMITPerson(org.kuali.coeus.propdev.api.person.ProposalPersonContract proposalPerson) This method determines whether a ProposalPersonContract is a Non MIT person
boolean	keyPersonEqualsBudgetPerson(KeyPersonDto keyPersonInfo, org.kuali.coeus.common.budget.api.personnel.BudgetPersonnelDetailsContract budgetPersonnelDetails) This method compares a key person with budget person.

Method Detail

getParticipantSupportCategoryCode

String getParticipantSupportCategoryCode()

getMatchingLineItems

List<? extends org.kuali.coeus.common.budget.api.nonpersonnel.BudgetLineItemContract> getMatchingLineItems(List<? extends org.kuali.coeus.common.budget.api.nonpersonnel.BudgetLineItemContract> lineItems,
                                                                                                         List<String> budgetCategoryType)

getBudgetCategoryMapList

List<? extends org.kuali.coeus.common.budget.api.core.category.BudgetCategoryMapContract> getBudgetCategoryMapList(List<String> filterTargetCategoryCodes,
                                                                                                                 List<String> filterCategoryTypes)

This method returns a list of BudgetCategoryMapContract 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

BudgetSummaryDto getBudgetInfo(org.kuali.coeus.propdev.api.core.ProposalDevelopmentDocumentContract pdDoc,
                             List<BudgetPeriodDto> budgetperiodList)
                               throws S2SException

This method does the budget related calculations for a given ProposalDevelopmentDocumentContract and returns them in BudgetSummaryDto

Parameters:

pdDoc - ProposalDevelopmentDocumentContract.

Returns:

BudgetSummaryInfo corresponding to the ProposalDevelopmentDocumentContract object.

Throws:

S2SException

getBudgetPeriods

List<BudgetPeriodDto> getBudgetPeriods(org.kuali.coeus.propdev.api.core.ProposalDevelopmentDocumentContract pdDoc)
                                       throws S2SException

This method gets the list of BudgetPeriodDto for the latest BudgetContract of the given ProposalDevelopmentDocumentContract

Parameters:

pdDoc - ProposalDevelopmentDocumentContract

Returns:

a List of BudgetPeriodInfo corresponding to the ProposalDevelopmentDocumentContract object.

Throws:

S2SException

isPersonNonMITPerson

boolean isPersonNonMITPerson(org.kuali.coeus.propdev.api.person.ProposalPersonContract proposalPerson)

This method determines whether a ProposalPersonContract is a Non MIT person

Parameters:

proposalPerson - ProposalPerson.

Returns:

boolean true if Non MIT Person false otherwise.

getIndirectCosts

IndirectCostDto getIndirectCosts(org.kuali.coeus.common.budget.api.core.BudgetContract budget,
                               org.kuali.coeus.common.budget.api.period.BudgetPeriodContract budgetPeriod)

This method computes the indirect costs for a given BudgetPeriodContract

Parameters:

budgetPeriod - given BudgetPeriod.

Returns:

IndirectCostInfo for the corresponding BudgetPeriod object.

getBaseSalaryByPeriod

org.kuali.coeus.sys.api.model.ScaleTwoDecimal getBaseSalaryByPeriod(Long budgetId,
                                                                  int budgetPeriod,
                                                                  KeyPersonDto keyPerson)

keyPersonEqualsBudgetPerson

boolean keyPersonEqualsBudgetPerson(KeyPersonDto keyPersonInfo,
                                  org.kuali.coeus.common.budget.api.personnel.BudgetPersonnelDetailsContract budgetPersonnelDetails)

This method compares a key person with budget person. It checks whether the key person is from PERSON or ROLODEX and matches the respective person ID with the person in BudgetPersonnelDetailsContract

Parameters:

keyPersonInfo - - key person to compare

budgetPersonnelDetails - person from BudgetPersonnelDetails

Returns:

true if persons match, false otherwise