org.kuali.kra.proposaldevelopment.service

Interface KeyPersonnelService

All Known Implementing Classes:

KeyPersonnelServiceImpl

public interface KeyPersonnelService

A Service for persisted modifications of Key Personnel related business objects

Version:

$Revision: 1.11 $

Author:

$Author: gmcgrego $

See Also:

ProposalPerson, ProposalDevelopmentKeyPersonnelAction, ProposalDevelopmentForm

Method Summary

Methods

Modifier and Type	Method and Description
void	addUnitToPerson(ProposalPerson person, ProposalPersonUnit unit) Add a ProposalPersonUnit instance to a ProposalPerson.
void	assignLeadUnit(ProposalPerson person, String unitNumber) Assigns the lead unit of the proposal to the given principal investigator
Map	calculateCreditSplitTotals(ProposalDevelopmentDocument document) Everytime something changes that will effect credit split values, this gets called to generate a graph of the new data.
ProposalPersonUnit	createProposalPersonUnit(String unitId, ProposalPerson person) Uses a Unit obtained from the Unit lookup on the ProposalDevelopmentForm to create a ProposalPersonUnit instance.
Collection<InvestigatorCreditType>	getInvestigatorCreditTypes() Create a Collection from all the ACTIVE InvestigatorCreditTypes stored persistently.
String	getPersonnelRoleDesc(PersonRolodex person)
String	getPrincipalInvestigatorRoleDescription(ProposalDevelopmentDocument document)
boolean	hasPrincipalInvestigator(ProposalDevelopmentDocument document) Determines if a {@link ProposalDevelopmentDocument has a PI composited in it anywhere
boolean	isCoInvestigator(ProposalPerson person) Determines if a given ProposalPerson instance is considered a COI.
boolean	isCreditSplitEnabled() Checks if the application-level configuration parameter for credit splits is enabled.
boolean	isInvestigator(ProposalPerson person) Determines if a given ProposalPerson instance is considered a PI or COI.
boolean	isKeyPerson(ProposalPerson person) Determines if a given ProposalPerson instance is considered a KP.
boolean	isPrincipalInvestigator(ProposalPerson person) Determines if a given ProposalPerson instance is considered a PI.
boolean	isRoleReadOnly(ProposalPersonRole role) Compares the roleId of the given ProposalPersonRole against the personrole.readonly.roles to see if it is read only or not.
boolean	isRoleReadOnly(String roleId) Compares the given roleId against the personrole.readonly.roles to see if it is read only or not.
Map<String,String>	loadKeyPersonnelRoleDescriptions(boolean sponsorIsNih) Load role descriptions based on whether sponsor is NIH-related
void	populateDocument(ProposalDevelopmentDocument document) Part of a complete breakfast, it has everything you need to populate Key Personnel into a ProposalDevelopmentDocument
void	populateProposalPerson(ProposalPerson person, ProposalDevelopmentDocument document) Part of a complete breakfast, it has everything you need to populate Key Personnel

Method Detail

populateDocument

void populateDocument(ProposalDevelopmentDocument document)

Part of a complete breakfast, it has everything you need to populate Key Personnel into a ProposalDevelopmentDocument

Parameters:

document -

populateProposalPerson

void populateProposalPerson(ProposalPerson person,
                          ProposalDevelopmentDocument document)

Part of a complete breakfast, it has everything you need to populate Key Personnel

Parameters:

person -

document -

getInvestigatorCreditTypes

Collection<InvestigatorCreditType> getInvestigatorCreditTypes()

Create a Collection from all the ACTIVE InvestigatorCreditTypes stored persistently.

Returns:

a Collection of InvestigatorCreditType instances.

addUnitToPerson

void addUnitToPerson(ProposalPerson person,
                   ProposalPersonUnit unit)

Add a ProposalPersonUnit instance to a ProposalPerson.

Parameters:

person -

unit -

calculateCreditSplitTotals

Map calculateCreditSplitTotals(ProposalDevelopmentDocument document)

Everytime something changes that will effect credit split values, this gets called to generate a graph of the new data.

Parameters:

document -

Returns:

Map

createProposalPersonUnit

ProposalPersonUnit createProposalPersonUnit(String unitId,
                                          ProposalPerson person)

Uses a Unit obtained from the Unit lookup on the ProposalDevelopmentForm to create a ProposalPersonUnit instance.

Parameters:

unitId -

Returns:

ProposalPersonUnit

isPrincipalInvestigator

boolean isPrincipalInvestigator(ProposalPerson person)

Determines if a given ProposalPerson instance is considered a PI. This is done by comparing the ProposalPersonRole of the ProposalPerson as a PI role.

Parameters:

person - ProposalPerson instance to compare

Returns:

true if the ProposalPerson is a PI

isCoInvestigator

boolean isCoInvestigator(ProposalPerson person)

Determines if a given ProposalPerson instance is considered a COI. This is done by comparing the ProposalPersonRole of the ProposalPerson as a COI role.

Parameters:

person - ProposalPerson instance to compare

Returns:

true if the ProposalPerson is a COI

isKeyPerson

boolean isKeyPerson(ProposalPerson person)

Determines if a given ProposalPerson instance is considered a KP. This is done by comparing the ProposalPersonRole of the ProposalPerson as a COI role.

Parameters:

person - ProposalPerson instance to compare

Returns:

true if the ProposalPerson is a COI

isInvestigator

boolean isInvestigator(ProposalPerson person)

Determines if a given ProposalPerson instance is considered a PI or COI. This is done by comparing the ProposalPersonRole of the ProposalPerson as a PI or COI role.

Parameters:

person - ProposalPerson instance to compare

Returns:

true if the ProposalPerson is a PI or COI

hasPrincipalInvestigator

boolean hasPrincipalInvestigator(ProposalDevelopmentDocument document)

Determines if a {@link ProposalDevelopmentDocument has a PI composited in it anywhere

Parameters:

document -

Returns:

true if the ProposalDevelopmentDocument has a PI

isCreditSplitEnabled

boolean isCreditSplitEnabled()

Checks if the application-level configuration parameter for credit splits is enabled. This allows credit splits to be used within the application

Returns:

true if credit split enabled configuration parameter is on

See Also:

CreditSplit

isRoleReadOnly

boolean isRoleReadOnly(String roleId)

Compares the given roleId against the personrole.readonly.roles to see if it is read only or not.

Parameters:

roleId - to check

Returns:

true if the roleId is a value in the personrole.readonly.roles system parameter, and false if the is null

See Also:

isRoleReadOnly(ProposalPersonRole)

isRoleReadOnly

boolean isRoleReadOnly(ProposalPersonRole role)

Compares the roleId of the given ProposalPersonRole against the personrole.readonly.roles to see if it is read only or not.

Parameters:

role - to check

Returns:

true if the role is a value in the personrole.readonly.roles system parameter, and false if the role is null

See Also:

isRoleReadOnly(String)

getPrincipalInvestigatorRoleDescription

String getPrincipalInvestigatorRoleDescription(ProposalDevelopmentDocument document)

Parameters:

document - to get Sponsor status

Returns:

Principal Investigator Role Description from the System Parameters

assignLeadUnit

void assignLeadUnit(ProposalPerson person,
                  String unitNumber)

Assigns the lead unit of the proposal to the given principal investigator

Parameters:

document -

person - Principal

loadKeyPersonnelRoleDescriptions

Map<String,String> loadKeyPersonnelRoleDescriptions(boolean sponsorIsNih)

Load role descriptions based on whether sponsor is NIH-related

Parameters:

sponsorIsNih -

Returns:

getPersonnelRoleDesc

String getPersonnelRoleDesc(PersonRolodex person)