org.kuali.kra.award.contacts

Class AwardPerson

java.lang.Object

org.kuali.rice.krad.bo.BusinessObjectBase

org.kuali.rice.krad.bo.PersistableBusinessObjectBase

org.kuali.kra.bo.KraPersistableBusinessObjectBase

org.kuali.kra.award.AwardAssociate

org.kuali.kra.award.contacts.AwardContact

org.kuali.kra.award.contacts.AwardPerson

All Implemented Interfaces:

Serializable, Comparable<AwardPerson>, org.apache.ojb.broker.PersistenceBrokerAware, AbstractProjectPerson, PersonRolodex, Sequenceable, SequenceAssociate<Award>, org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.core.api.mo.ModelObjectBasic, org.kuali.rice.krad.bo.BusinessObject, org.kuali.rice.krad.bo.PersistableBusinessObject

public class AwardPerson
extends AwardContact
implements PersonRolodex, Comparable<AwardPerson>, AbstractProjectPerson

This class implements an Award Person

See Also:

Serialized Form

Field Summary

Fields inherited from class org.kuali.kra.award.contacts.AwardContact

personId, roleCode, rolodexId

Fields inherited from class org.kuali.kra.bo.KraPersistableBusinessObjectBase

UPDATE_USER_LENGTH

Fields inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

extension, versionNumber

Constructor Summary

Constructors

Constructor and Description
AwardPerson()
AwardPerson(KcPerson person, ContactRole role)
AwardPerson(NonOrganizationalRolodex rolodex, ContactRole contactRole)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(AwardPersonCreditSplit creditSplit)
void	add(AwardPersonUnit awardPersonUnit) This method associates a unit to the
List	buildListOfDeletionAwareLists()
int	compareTo(AwardPerson o)
Unit	findLeadUnit() This method finds the lead unit for an AwardPerson
org.kuali.rice.core.api.util.type.KualiDecimal	getAcademicYearEffort() Gets the academicYearEffort attribute.
org.kuali.rice.core.api.util.type.KualiDecimal	getCalendarYearEffort() Gets the calendarYearEffort attribute.
protected Class	getContactRoleType() This method specifies the actual class implementing ContactRole
protected String	getContactRoleTypeIdentifier() This method specifies the identifier of the actual type implementing ContactRole
AwardPersonCreditSplit	getCreditSplit(int index)
List<AwardPersonCreditSplit>	getCreditSplits()
String	getFirstName()
String	getInvestigatorRoleDescription()
boolean	getIsRolodexPerson()
String	getKeyPersonRole()
String	getLastName()
Sponsorable	getParent()
String	getProjectRole()
org.kuali.rice.core.api.util.type.KualiDecimal	getSummerEffort() Gets the summerEffort attribute.
org.kuali.rice.core.api.util.type.KualiDecimal	getTotalEffort() Gets the totalEffort attribute.
AwardPersonUnit	getUnit(int index)
AwardPersonUnit	getUnit(String unitNumber) Get the award unit if it exists from this person
List<AwardPersonUnit>	getUnits() Gets the units attribute.
protected void	init()
boolean	isCoInvestigator() This method determines if person is CO-I
boolean	isFaculty() Gets the faculty attribute.
boolean	isKeyPerson() This method determines if person is KeyPerson
boolean	isMultiplePi()
boolean	isOptInUnitStatus()
boolean	isOtherSignificantContributorFlag()
boolean	isPrincipalInvestigator()
void	setAcademicYearEffort(org.kuali.rice.core.api.util.type.KualiDecimal academicYearEffort) Sets the academicYearEffort attribute value.
void	setCalendarYearEffort(org.kuali.rice.core.api.util.type.KualiDecimal calendarYearEffort) Sets the calendarYearEffort attribute value.
void	setCreditSplits(List<AwardPersonCreditSplit> creditSplits) Sets the creditSplits attribute value.
void	setFaculty(boolean faculty) Sets the faculty attribute value.
void	setKeyPersonRole(String keyPersonRole)
void	setMultiplePi(boolean multiplePi)
void	setOptInUnitStatus(boolean optInUnitStatus)
void	setSummerEffort(org.kuali.rice.core.api.util.type.KualiDecimal summerEffort) Sets the summerEffort attribute value.
void	setTotalEffort(org.kuali.rice.core.api.util.type.KualiDecimal totalEffort) Sets the totalEffort attribute value.
void	setUnits(List<AwardPersonUnit> units) Sets the units attribute value.
String	toString()

Methods inherited from class org.kuali.kra.award.contacts.AwardContact

equals, getAwardContactId, getBusinessObjectService, getContact, getContactOrganizationName, getContactRole, getContactRoleCode, getEmailAddress, getFullName, getGenericId, getIdentifierMap, getKcPersonService, getOrganizationIdentifier, getPerson, getPersonId, getPhoneNumber, getRoleCode, getRolodex, getRolodexId, hashCode, isEmployee, refreshContactRole, refreshPerson, refreshRolodex, resetPersistenceState, setAwardContactId, setContactRole, setContactRoleCode, setEmailAddress, setFullName, setPerson, setPersonId, setPhoneNumber, setRoleCode, setRolodex, setRolodexId, setUnitName

Methods inherited from class org.kuali.kra.award.AwardAssociate

getAward, getAwardNumber, getSequenceNumber, getSequenceOwner, prePersist, setAward, setAwardNumber, setSequenceNumber, setSequenceOwner

Methods inherited from class org.kuali.kra.bo.KraPersistableBusinessObjectBase

getAuthorPersonName, getUpdateTimestamp, getUpdateUser, isUpdateUserSet, postPersist, preUpdate, setUpdateTimestamp, setUpdateUser, setUpdateUserSet

Methods inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, getExtension, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isNewCollectionRecord, linkEditableUserFields, postLoad, postRemove, postUpdate, preRemove, refresh, refreshNonUpdateableReferences, refreshReferenceObject, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.kuali.kra.budget.personnel.PersonRolodex

getContactRole, getFullName, getPersonId, getRolodexId

Methods inherited from interface org.kuali.kra.bo.AbstractProjectPerson

getFullName, getPerson, getPersonId, getRoleCode, getRolodexId

Constructor Detail

AwardPerson

public AwardPerson()

AwardPerson

public AwardPerson(NonOrganizationalRolodex rolodex,
           ContactRole contactRole)

AwardPerson

public AwardPerson(KcPerson person,
           ContactRole role)

Method Detail

add

public void add(AwardPersonCreditSplit creditSplit)

Parameters:

creditSplit -

add

public void add(AwardPersonUnit awardPersonUnit)

This method associates a unit to the

Parameters:

unit -

isLeadUnit -

buildListOfDeletionAwareLists

public List buildListOfDeletionAwareLists()

Specified by:

buildListOfDeletionAwareLists in interface org.kuali.rice.krad.bo.PersistableBusinessObject

Overrides:

buildListOfDeletionAwareLists in class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

See Also:

org.kuali.core.bo.PersistableBusinessObjectBase#buildListOfDeletionAwareLists()

findLeadUnit

public Unit findLeadUnit()

This method finds the lead unit for an AwardPerson

Returns:

getAcademicYearEffort

public org.kuali.rice.core.api.util.type.KualiDecimal getAcademicYearEffort()

Gets the academicYearEffort attribute.

Returns:

Returns the academicYearEffort.

getCalendarYearEffort

public org.kuali.rice.core.api.util.type.KualiDecimal getCalendarYearEffort()

Gets the calendarYearEffort attribute.

Returns:

Returns the calendarYearEffort.

getCreditSplit

public AwardPersonCreditSplit getCreditSplit(int index)

Parameters:

index -

Returns:

getCreditSplits

public List<AwardPersonCreditSplit> getCreditSplits()

Returns:

getSummerEffort

public org.kuali.rice.core.api.util.type.KualiDecimal getSummerEffort()

Gets the summerEffort attribute.

Returns:

Returns the summerEffort.

getTotalEffort

public org.kuali.rice.core.api.util.type.KualiDecimal getTotalEffort()

Gets the totalEffort attribute.

Returns:

Returns the totalEffort.

getUnit

public AwardPersonUnit getUnit(int index)

Parameters:

index -

Returns:

getUnit

public AwardPersonUnit getUnit(String unitNumber)

Get the award unit if it exists from this person

Parameters:

unitNumber - String

Returns:

AwardPersonUnit

getUnits

public List<AwardPersonUnit> getUnits()

Gets the units attribute.

Returns:

Returns the units.

isCoInvestigator

public boolean isCoInvestigator()

This method determines if person is CO-I

Returns:

isFaculty

public boolean isFaculty()

Gets the faculty attribute.

Returns:

Returns the faculty.

isKeyPerson

public boolean isKeyPerson()

This method determines if person is KeyPerson

Returns:

isPrincipalInvestigator

public boolean isPrincipalInvestigator()

Returns:

setAcademicYearEffort

public void setAcademicYearEffort(org.kuali.rice.core.api.util.type.KualiDecimal academicYearEffort)

Sets the academicYearEffort attribute value.

Parameters:

academicYearEffort - The academicYearEffort to set.

setCalendarYearEffort

public void setCalendarYearEffort(org.kuali.rice.core.api.util.type.KualiDecimal calendarYearEffort)

Sets the calendarYearEffort attribute value.

Parameters:

calendarYearEffort - The calendarYearEffort to set.

setCreditSplits

public void setCreditSplits(List<AwardPersonCreditSplit> creditSplits)

Sets the creditSplits attribute value.

Parameters:

creditSplits - The creditSplits to set.

setFaculty

public void setFaculty(boolean faculty)

Sets the faculty attribute value.

Parameters:

faculty - The faculty to set.

setSummerEffort

public void setSummerEffort(org.kuali.rice.core.api.util.type.KualiDecimal summerEffort)

Sets the summerEffort attribute value.

Parameters:

summerEffort - The summerEffort to set.

setTotalEffort

public void setTotalEffort(org.kuali.rice.core.api.util.type.KualiDecimal totalEffort)

Sets the totalEffort attribute value.

Parameters:

totalEffort - The totalEffort to set.

setUnits

public void setUnits(List<AwardPersonUnit> units)

Sets the units attribute value.

Parameters:

units - The units to set.

toString

public String toString()

Specified by:

toString in interface org.kuali.rice.core.api.mo.ModelObjectBasic

Overrides:

toString in class org.kuali.rice.krad.bo.BusinessObjectBase

getContactRoleType

protected Class getContactRoleType()

Description copied from class: AwardContact

This method specifies the actual class implementing ContactRole

Specified by:

getContactRoleType in class AwardContact

Returns:

See Also:

AwardContact.getContactRoleType()

getContactRoleTypeIdentifier

protected String getContactRoleTypeIdentifier()

Description copied from class: AwardContact

This method specifies the identifier of the actual type implementing ContactRole

Specified by:

getContactRoleTypeIdentifier in class AwardContact

Returns:

See Also:

AwardContact.getContactRoleTypeIdentifier()

init

protected void init()

getProjectRole

public String getProjectRole()

Specified by:

getProjectRole in interface PersonRolodex

isOtherSignificantContributorFlag

public boolean isOtherSignificantContributorFlag()

Specified by:

isOtherSignificantContributorFlag in interface PersonRolodex

getKeyPersonRole

public String getKeyPersonRole()

setKeyPersonRole

public void setKeyPersonRole(String keyPersonRole)

compareTo

public int compareTo(AwardPerson o)

Specified by:

compareTo in interface Comparable<AwardPerson>

See Also:

Comparable.compareTo(java.lang.Object)

isMultiplePi

public boolean isMultiplePi()

Specified by:

isMultiplePi in interface PersonRolodex

setMultiplePi

public void setMultiplePi(boolean multiplePi)

getParent

public Sponsorable getParent()

Specified by:

getParent in interface AbstractProjectPerson

Specified by:

getParent in interface PersonRolodex

getInvestigatorRoleDescription

public String getInvestigatorRoleDescription()

Specified by:

getInvestigatorRoleDescription in interface PersonRolodex

isOptInUnitStatus

public boolean isOptInUnitStatus()

setOptInUnitStatus

public void setOptInUnitStatus(boolean optInUnitStatus)

getLastName

public String getLastName()

getFirstName

public String getFirstName()

getIsRolodexPerson

public boolean getIsRolodexPerson()