org.kuali.kra.s2s.service.impl

Class S2SBudgetCalculatorServiceImpl

java.lang.Object

org.kuali.kra.s2s.service.impl.S2SBudgetCalculatorServiceImpl

All Implemented Interfaces:

S2SBudgetCalculatorService

public class S2SBudgetCalculatorServiceImpl
extends Object
implements S2SBudgetCalculatorService

This class contains the implementation for common budget calculations required for S2S Form generators

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_MAPPING_NAME
static String	KEY_TARGET_CATEGORY_CODE

Constructor Summary

Constructors

Constructor and Description
S2SBudgetCalculatorServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	budgetPersonExistInProposalPersons(BudgetPerson budgetPerson, List<ProposalPerson> propPersons)
List<BudgetCategoryMap>	getBudgetCategoryMapList(List<String> filterTargetCategoryCodes, List<String> filterCategoryTypes) This method returns a list of BudgetCategoryMap based on the input.
protected List<BudgetCategoryMapping>	getBudgetCategoryMappings(Map<String,String> conditionMap)
BudgetSummaryInfo	getBudgetInfo(ProposalDevelopmentDocument pdDoc, List<BudgetPeriodInfo> budgetPeriodInfos) 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
protected CompensationInfo	getCompensation(KeyPersonInfo keyPerson, BudgetPeriod budgetPeriod, String proposalNumber) This method computes the CompensationInfo for given person, BudgetPeriod and Proposal Numnber
protected List<EquipmentInfo>	getEquipment(BudgetPeriod budgetPeriod) This method computes the Equipment Costs for a given BudgetPeriod
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
protected List<List<KeyPersonInfo>>	getKeyPersons(BudgetPeriod budgetPeriod, ProposalDevelopmentDocument pdDoc, int numKeyPersons) This method gets the List of Key Persons for a given ProposalDevelopmentDocument
protected List<KeyPersonInfo>	getNKeyPersons(List<KeyPersonInfo> keyPersons, boolean firstN, int n) This method limits the number of key persons to n, returns list of key persons, first n in case firstN is true, or all other than first n, in case of firstN being false
protected List<OtherDirectCostInfo>	getOtherDirectCosts(BudgetPeriod budgetPeriod, String sponsor) This method computes Other Dirtect Costs for the given BudgetPeriod and Sponsor
protected List<OtherPersonnelInfo>	getOtherPersonnel(BudgetPeriod budgetPeriod, ProposalDevelopmentDocument pdDoc) This method populates the OtherPersonnelInfo business objects for the given BudgetPeriod and ProposalDevelopmentDocument
protected OtherPersonnelInfo	getOtherPersonnelDetails(BudgetPeriod budgetPeriod, ProposalDevelopmentDocument pdDoc, String category, String personnelType, String role) This method populates the details for OtherPersonnelInfo business object for the given ProposalDevelopmentDocument
protected org.kuali.rice.coreservice.framework.parameter.ParameterService	getParameterService()
BudgetDecimal	getProposalPersonSalary(ProposalDevelopmentDocument pdDoc, ProposalPerson proposalPerson) This method gets the salary requested for a given proposal person.
boolean	isBudgetSummaryCostShareParameterValueEnabled(Budget budget)
boolean	isPersonNonMITPerson(ProposalPerson proposalPerson) This method determines whether a ProposalPerson is a Non MIT person
void	setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService) This method is to set businessObjectService
void	setKcPersonService(KcPersonService kcPersonService) Sets the KC Person Service.
void	setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService)
void	setRolodexService(RolodexService rolodexService)
void	setS2SUtilService(S2SUtilService s2SUtilService) Sets the s2sUtilService attribute value.

Methods inherited from class java.lang.Object

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

Field Detail

KEY_MAPPING_NAME

public static final String KEY_MAPPING_NAME

See Also:

Constant Field Values

KEY_TARGET_CATEGORY_CODE

public static final String KEY_TARGET_CATEGORY_CODE

See Also:

Constant Field Values

Constructor Detail

S2SBudgetCalculatorServiceImpl

public S2SBudgetCalculatorServiceImpl()

Method Detail

getParameterService

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

setParameterService

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

isBudgetSummaryCostShareParameterValueEnabled

public boolean isBudgetSummaryCostShareParameterValueEnabled(Budget budget)

getBudgetInfo

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

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

Specified by:

getBudgetInfo in interface S2SBudgetCalculatorService

Parameters:

pdDoc - ProposalDevelopmentDocument.

Returns:

BudgetSummaryInfo corresponding to the ProposalDevelopmentDocument object.

Throws:

S2SException

See Also:

org.kuali.kra.s2s.service.S2SBudgetCalculatorService#getBudgetInfo(org.kuali.kra.proposaldevelopment.document.ProposalDevelopmentDocument)

getBudgetPeriods

public List<BudgetPeriodInfo> getBudgetPeriods(ProposalDevelopmentDocument pdDoc)
                                        throws S2SException

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

Specified by:

getBudgetPeriods in interface S2SBudgetCalculatorService

Parameters:

pdDoc - ProposalDevelopmentDocument

Returns:

a List of BudgetPeriodInfo corresponding to the ProposalDevelopmentDocument object.

Throws:

S2SException

See Also:

S2SBudgetCalculatorService.getBudgetPeriods(org.kuali.kra.proposaldevelopment.document.ProposalDevelopmentDocument)

getOtherPersonnel

protected List<OtherPersonnelInfo> getOtherPersonnel(BudgetPeriod budgetPeriod,
                                         ProposalDevelopmentDocument pdDoc)

This method populates the OtherPersonnelInfo business objects for the given BudgetPeriod and ProposalDevelopmentDocument

Parameters:

budgetPeriod - given budget period.

pdDoc - Proposal Development Document.

Returns:

List of OtherPersonnelInfo

getOtherPersonnelDetails

protected OtherPersonnelInfo getOtherPersonnelDetails(BudgetPeriod budgetPeriod,
                                          ProposalDevelopmentDocument pdDoc,
                                          String category,
                                          String personnelType,
                                          String role)

This method populates the details for OtherPersonnelInfo business object for the given ProposalDevelopmentDocument

Parameters:

budgetPeriod - given budget period.

pdDoc - Proposal Development Document.

category - budget category

personnelType - proposal personnel type.

role - role of the proposal person.

Returns:

OtherPersonnelInfo information about the other personnel.

getIndirectCosts

public IndirectCostInfo getIndirectCosts(Budget budget,
                                BudgetPeriod budgetPeriod)

This method computes the indirect costs for a given BudgetPeriod

Specified by:

getIndirectCosts in interface S2SBudgetCalculatorService

Parameters:

budgetPeriod - given BudgetPeriod.

Returns:

IndirectCostInfo for the corresponding BudgetPeriod object.

getOtherDirectCosts

protected List<OtherDirectCostInfo> getOtherDirectCosts(BudgetPeriod budgetPeriod,
                                            String sponsor)

This method computes Other Dirtect Costs for the given BudgetPeriod and Sponsor

Parameters:

budgetPeriod - given BudgetPeriod.

sponsor - sponsor detail.

Returns:

List list of OtherDirectCostInfo corresponding to the BudgetPeriod object.

getBudgetCategoryMapList

public 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.

Specified by:

getBudgetCategoryMapList in interface S2SBudgetCalculatorService

Parameters:

filterTargetCategoryCodes - Category Codes that must be filtered

filterCategoryTypes - Category types that must be filtered

Returns:

a List of BudgetCategoryMap.

See Also:

S2SBudgetCalculatorService.getBudgetCategoryMapList(java.util.List, java.util.List)

getEquipment

protected List<EquipmentInfo> getEquipment(BudgetPeriod budgetPeriod)

This method computes the Equipment Costs for a given BudgetPeriod

Parameters:

budgetPeriod - given BudgetPeriod.

Returns:

List list of equipment cost corresponding to the BudgetPeriod object.

getKeyPersons

protected List<List<KeyPersonInfo>> getKeyPersons(BudgetPeriod budgetPeriod,
                                      ProposalDevelopmentDocument pdDoc,
                                      int numKeyPersons)

This method gets the List of Key Persons for a given ProposalDevelopmentDocument

Parameters:

budgetPeriod - given BudgetPeriod.

pdDoc - Proposal Development Document.

numKeyPersons - number of key persons.

Returns:

List> list of KeyPersonInfo list.

budgetPersonExistInProposalPersons

protected boolean budgetPersonExistInProposalPersons(BudgetPerson budgetPerson,
                                         List<ProposalPerson> propPersons)

isPersonNonMITPerson

public boolean isPersonNonMITPerson(ProposalPerson proposalPerson)

This method determines whether a ProposalPerson is a Non MIT person

Specified by:

isPersonNonMITPerson in interface S2SBudgetCalculatorService

Parameters:

proposalPerson - ProposalPerson.

Returns:

boolean true if Non MIT Person false otherwise.

See Also:

S2SBudgetCalculatorService.isPersonNonMITPerson(org.kuali.kra.proposaldevelopment.bo.ProposalPerson)

getBudgetCategoryMappings

protected List<BudgetCategoryMapping> getBudgetCategoryMappings(Map<String,String> conditionMap)

getCompensation

protected CompensationInfo getCompensation(KeyPersonInfo keyPerson,
                               BudgetPeriod budgetPeriod,
                               String proposalNumber)

This method computes the CompensationInfo for given person, BudgetPeriod and Proposal Numnber

Parameters:

personId - id of the proposal person.

budgetPeriod - given BudgetPeriod.

proposalNumber - propsal number.

Returns:

CompensationInfo corresponding to the personId,budgetPeriod and proposalNumber.

getNKeyPersons

protected List<KeyPersonInfo> getNKeyPersons(List<KeyPersonInfo> keyPersons,
                                 boolean firstN,
                                 int n)

This method limits the number of key persons to n, returns list of key persons, first n in case firstN is true, or all other than first n, in case of firstN being false

Parameters:

keyPersons - list of KeyPersonInfo

firstN - value that determines whether the returned list should contain first n persons or the rest of persons

n - number of key persons that are considered as not extra persons

Returns:

list of KeyPersonInfo

getFinalBudgetVersion

public BudgetDocument getFinalBudgetVersion(ProposalDevelopmentDocument pdDoc)
                                     throws S2SException

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

Specified by:

getFinalBudgetVersion in interface S2SBudgetCalculatorService

Parameters:

pdDoc - Proposal development document.

Returns:

BudgetDocument final version of budget corresponding to the ProposalDevelopmentDocument object.

Throws:

S2SException

See Also:

S2SBudgetCalculatorService.getFinalBudgetVersion(org.kuali.kra.proposaldevelopment.document.ProposalDevelopmentDocument)

getProposalPersonSalary

public BudgetDecimal getProposalPersonSalary(ProposalDevelopmentDocument pdDoc,
                                    ProposalPerson proposalPerson)
                                      throws S2SException

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

Specified by:

getProposalPersonSalary in interface S2SBudgetCalculatorService

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

setS2SUtilService

public void setS2SUtilService(S2SUtilService s2SUtilService)

Sets the s2sUtilService attribute value.

Parameters:

generatorUtilService - The s2sUtilService to set.

setBusinessObjectService

public void setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)

This method is to set businessObjectService

Parameters:

businessObjectService(BusinessObjectService) -

setKcPersonService

public void setKcPersonService(KcPersonService kcPersonService)

Sets the KC Person Service.

Parameters:

kcPersonService - the kc person service

setRolodexService

public void setRolodexService(RolodexService rolodexService)

Parameters:

rolodexService - the rolodexService to set