org.kuali.kra.protocol.personnel

Interface ProtocolPersonnelService

All Known Subinterfaces:

IacucProtocolPersonnelService, ProtocolPersonnelService

All Known Implementing Classes:

IacucProtocolPersonnelServiceImpl, ProtocolPersonnelServiceImpl, ProtocolPersonnelServiceImplBase

public interface ProtocolPersonnelService

Method Summary

Methods

Modifier and Type	Method and Description
void	addProtocolPerson(ProtocolBase protocol, ProtocolPersonBase protocolPerson) This method adds ProtocolPersonBase to the List of ProtocolPersons.
void	addProtocolPersonAttachment(ProtocolBase protocol, ProtocolAttachmentPersonnelBase newAttachment, int selectedPersonIndex) This method add ProtocolPersonAttachment to a Person of the ProtocolBase.
void	addProtocolPersonUnit(List<ProtocolUnitBase> protocolPersonUnits, ProtocolPersonBase protocolPerson, int selectedPersonIndex) This method adds ProtocolUnitBase to the List of selected ProtocolPersonBase.
void	deleteProtocolPerson(ProtocolBase protocol) This method deletes ProtocolPersonBase(s) - those marked as delete
void	deleteProtocolPersonUnit(ProtocolBase protocol, int selectedPersonIndex, int lineNumber) This method will delete ProtocolUnitBase from the List of protocol person units at specified position(selectedPersonIndex)
List<Integer>	getAffiliationStudentMap(List<ProtocolPersonBase> protocolPersons) This method returns a list of affiliated students from a list of personnel.
ProtocolUnitBase	getLeadUnit(ProtocolPersonBase principalInvestigator) This method gets the lead unit of the principal investigator.
List<ProtocolPersonRoleMappingBase>	getPersonRoleMapping(String sourceRoleId) This method is to get valid target person roles for a given source role.
ProtocolPersonBase	getPrincipalInvestigator(List<ProtocolPersonBase> protocolPersons) This method is to get principal investigator person This method also helps to check whether at least one investigator exists in person list Return first found investigator so that we can check for duplicate if any
ProtocolPersonRoleBase	getProtocolPersonRole(String sourceRoleId) This method returns the protocolPersonRole based on the sourceRoleId.
boolean	isDuplicatePerson(List<ProtocolPersonBase> protocolPersons, ProtocolPersonBase newProtocolPerson) This method is to check for duplicate person.
boolean	isDuplicateUnit(ProtocolPersonBase protocolPerson, ProtocolUnitBase newProtocolUnit) This method is to check whether new unit already exists in the list for a person
boolean	isPIExists(List<ProtocolPersonBase> protocolPersons) This method is to check if Principal Investigator already exists.
boolean	isPISameAsCoI(ProtocolPersonBase piProtocolPerson, ProtocolPersonBase newProtocolPerson) This method is to check if the person playing the PI role is also being added as a CO-I
boolean	isPrincipalInvestigator(ProtocolPersonBase protocolPerson) This method is to check whether a person has role of Principal Investigator
boolean	isValidStudentFacultyMatch(List<ProtocolPersonBase> protocolPersons) This method is to check whether Student Investigator and Faculty Supervisor combination is valid.
void	selectProtocolUnit(List<ProtocolPersonBase> protocolPersons) This method is to select protocol lead unit for each person.
void	setLeadUnit(ProtocolUnitBase newLeadUnit, ProtocolPersonBase principalInvestigator, ProtocolBase protocol) This method sets the lead unit of the principal investigator.
void	setPrincipalInvestigator(ProtocolPersonBase newPrincipalInvestigator, ProtocolBase protocol) This method sets the principal investigator.
void	switchInvestigatorCoInvestigatorRole(List<ProtocolPersonBase> protocolPersons) This method is to see if there is any change in the protocol person role.
void	syncPersonRoleAndAffiliation(ProtocolPersonBase protocolPerson) This method is to update person affiliation type based on change in person role.
void	syncPersonRoleAndUnit(ProtocolPersonBase protocolPerson) This method is to update person unit based on change in person role.
void	syncProtocolPersonRoleChanges(List<ProtocolPersonBase> protocolPersons) This method is used to update selected protocol lead unit in the list.

Method Detail

addProtocolPerson

void addProtocolPerson(ProtocolBase protocol,
                     ProtocolPersonBase protocolPerson)

This method adds ProtocolPersonBase to the List of ProtocolPersons.

Parameters:

protocol - which contains list of ProtocolPersons.

ProtocolPersonBase - object is added to ProtocolPersons list.

deleteProtocolPerson

void deleteProtocolPerson(ProtocolBase protocol)

This method deletes ProtocolPersonBase(s) - those marked as delete

Parameters:

protocol - which contains list of ProtocolPersons

addProtocolPersonAttachment

void addProtocolPersonAttachment(ProtocolBase protocol,
                               ProtocolAttachmentPersonnelBase newAttachment,
                               int selectedPersonIndex)

This method add ProtocolPersonAttachment to a Person of the ProtocolBase.

Parameters:

protocol - - the protocol

newAttachment - - the new attachment to be added

selectedPersonIndex - - the attachment is added to the specific person in the list

addProtocolPersonUnit

void addProtocolPersonUnit(List<ProtocolUnitBase> protocolPersonUnits,
                         ProtocolPersonBase protocolPerson,
                         int selectedPersonIndex)

This method adds ProtocolUnitBase to the List of selected ProtocolPersonBase.

Parameters:

protocolPersonUnits - - New list of protocol units for each person

protocolPerson - - Selected protocol person from the list

selectedPersonIndex - - Unit is added to specific person in the list

deleteProtocolPersonUnit

void deleteProtocolPersonUnit(ProtocolBase protocol,
                            int selectedPersonIndex,
                            int lineNumber)

This method will delete ProtocolUnitBase from the List of protocol person units at specified position(selectedPersonIndex)

Parameters:

protocolPersonUnits - - New list of protocol units for each person

selectedPersonIndex - - Unit is removed from specific person in the list

lineNumber - - deleted line number

syncProtocolPersonRoleChanges

void syncProtocolPersonRoleChanges(List<ProtocolPersonBase> protocolPersons)

This method is used to update selected protocol lead unit in the list. Each ProtocolBase Person has index of selected lead unit UI display is handled through selectedUnit index to group lead unit radio. Update selected unit in the list based on selectedUnit indicator in each protocolPerson Also update affiliation type which is linked to person role.

Parameters:

protocolPersons -

selectProtocolUnit

void selectProtocolUnit(List<ProtocolPersonBase> protocolPersons)

This method is to select protocol lead unit for each person. UI display is handled through selectedUnit index to group lead unit radio. So we need to set this indicator for each person once we fetch all protocolPersons.

Parameters:

protocolPersons -

isPIExists

boolean isPIExists(List<ProtocolPersonBase> protocolPersons)

This method is to check if Principal Investigator already exists. Only one Principal Investigator may be assigned to each protocol

Parameters:

protocolPersons -

Returns:

true / false

isDuplicatePerson

boolean isDuplicatePerson(List<ProtocolPersonBase> protocolPersons,
                        ProtocolPersonBase newProtocolPerson)

This method is to check for duplicate person. Same person can be listed in multiple roles. Validate with person and role

Parameters:

protocolPersons -

newProtocolPerson -

Returns:

true / false

getPrincipalInvestigator

ProtocolPersonBase getPrincipalInvestigator(List<ProtocolPersonBase> protocolPersons)

This method is to get principal investigator person This method also helps to check whether at least one investigator exists in person list Return first found investigator so that we can check for duplicate if any

Parameters:

protocolPersons -

Returns:

null if no investigator else ProtocolPersonBase as investigator

isPrincipalInvestigator

boolean isPrincipalInvestigator(ProtocolPersonBase protocolPerson)

This method is to check whether a person has role of Principal Investigator

Parameters:

protocolPerson -

Returns:

setPrincipalInvestigator

void setPrincipalInvestigator(ProtocolPersonBase newPrincipalInvestigator,
                            ProtocolBase protocol)

This method sets the principal investigator.

Parameters:

newPrincipalInvestigator - The new instance of the principal investigator

protocol - The protocol that will contain the investigator

getLeadUnit

ProtocolUnitBase getLeadUnit(ProtocolPersonBase principalInvestigator)

This method gets the lead unit of the principal investigator.

Parameters:

principalInvestigator - The principal investigator to search

Returns:

The lead unit associated with the principal investigator

setLeadUnit

void setLeadUnit(ProtocolUnitBase newLeadUnit,
               ProtocolPersonBase principalInvestigator,
               ProtocolBase protocol)

This method sets the lead unit of the principal investigator.

Parameters:

newLeadUnit - The new instance of the lead unit

principalInvestigator - The principal investigator to set

protocol - The protocol that contains the principal investigator

switchInvestigatorCoInvestigatorRole

void switchInvestigatorCoInvestigatorRole(List<ProtocolPersonBase> protocolPersons)

This method is to see if there is any change in the protocol person role. swapping Investigator and Co-Investigator role is permitted. If Co-investigator is made a PI then the previous PI automatically is made a Co-investigator and vice versa

Parameters:

protocolPersons -

getPersonRoleMapping

List<ProtocolPersonRoleMappingBase> getPersonRoleMapping(String sourceRoleId)

This method is to get valid target person roles for a given source role. A role can be changed only to specific other roles defined.

Parameters:

sourceRoleId -

Returns:

getProtocolPersonRole

ProtocolPersonRoleBase getProtocolPersonRole(String sourceRoleId)

This method returns the protocolPersonRole based on the sourceRoleId.

Parameters:

sourceRoleId -

Returns:

isDuplicateUnit

boolean isDuplicateUnit(ProtocolPersonBase protocolPerson,
                      ProtocolUnitBase newProtocolUnit)

This method is to check whether new unit already exists in the list for a person

Parameters:

protocolPerson -

newProtocolUnit -

Returns:

true / false

syncPersonRoleAndUnit

void syncPersonRoleAndUnit(ProtocolPersonBase protocolPerson)

This method is to update person unit based on change in person role.

Parameters:

protocolPerson -

syncPersonRoleAndAffiliation

void syncPersonRoleAndAffiliation(ProtocolPersonBase protocolPerson)

This method is to update person affiliation type based on change in person role.

Parameters:

protocolPerson -

isValidStudentFacultyMatch

boolean isValidStudentFacultyMatch(List<ProtocolPersonBase> protocolPersons)

This method is to check whether Student Investigator and Faculty Supervisor combination is valid. If one PI or Co-Investigator has Student Investigator selected as Affiliation type then another PI or Co-Investigator must have Faculty Supervisor check. There may be multiple student investigators and faculty supervisors. This check is done prior to submission

Parameters:

protocolPersons -

Returns:

isPISameAsCoI

boolean isPISameAsCoI(ProtocolPersonBase piProtocolPerson,
                    ProtocolPersonBase newProtocolPerson)

This method is to check if the person playing the PI role is also being added as a CO-I

Parameters:

protocolPersons -

newProtocolPerson -

Returns:

getAffiliationStudentMap

List<Integer> getAffiliationStudentMap(List<ProtocolPersonBase> protocolPersons)

This method returns a list of affiliated students from a list of personnel.

Parameters:

protocolPersons -

Returns:

affiliatedStudents