org.kuali.kra.bo

Class KcPerson

java.lang.Object

org.kuali.kra.bo.KcPerson

All Implemented Interfaces:

Serializable, Contactable, org.kuali.rice.core.api.mo.ModelObjectBasic, org.kuali.rice.krad.bo.BusinessObject

public class KcPerson
extends Object
implements Contactable, org.kuali.rice.krad.bo.BusinessObject

Represents a person in KC.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
KcPerson() When using this ctor setPersonId(String) must be call else this call is in an invalid state.

Method Summary

Methods

Modifier and Type	Method and Description
static KcPerson	fromEntityAndPersonId(org.kuali.rice.kim.api.identity.entity.EntityContract entity, String personId) Creates a KcPerson from an EntityContract & principalId.
static KcPerson	fromEntityAndUserName(org.kuali.rice.kim.api.identity.entity.EntityContract entity, String userName) Creates a KcPerson from an EntityContract & principalId.
static KcPerson	fromExtendedAttributes(KcPersonExtendedAttributes extendedAttributes) Creates a KcPerson from an KcPersonExtendedAttributes BO.
static KcPerson	fromPersonId(String personId) Creates a KcPerson from a principal id.
Boolean	getActive() Gets the active flag.
String	getAddressLine1() Gets the value of addressLine1.
String	getAddressLine2() Gets the value of addressLine2.
String	getAddressLine3() Gets the value of addressLine3.
Integer	getAge() Gets the value of age.
Integer	getAgeByFiscalYear() Gets the value of ageByFiscalYear.
String	getCampusCode() Gets the campus code.
String	getCity() Gets the value of city.
String	getContactOrganizationName() This method returns the contact's organization name.
String	getCountryCode() Gets the value of countryCode.
String	getCountryOfCitizenship() Gets the value of countryOfCitizenship.
String	getCounty() Gets the value of county.
String	getDateOfBirth() Gets the value of dateOfBirth.
String	getDegree() Gets the value of degree.
String	getDirectoryDepartment() Gets the value of directoryDepartment.
String	getDirectoryTitle() Gets the value of directoryTitle.
String	getEducationLevel() Gets the value of educationLevel.
String	getEmailAddress() Gets the value of emailAddress.
String	getEraCommonsUserName() Gets the value of eraCommonsUserName.
KcPersonExtendedAttributes	getExtendedAttributes() gets the extended attributes BO.
Boolean	getFacultyFlag() Gets the value of faculty.
String	getFaxNumber() Gets the value of faxNumber.
String	getFirstName() Gets the value of firstName.
String	getFullName() Gets the value of fullName.
String	getGender() Gets the value of gender.
Boolean	getGraduateStudentStaffFlag() Gets the value of graduateStudentStaff.
Boolean	getHandicappedFlag() Gets the value of handicapped.
String	getHandicapType() Gets the value of handicapType.
Boolean	getHasVisa() Gets the value of hasVisa.
String	getIdentifier() This method returns the serializable identifier of the contact.
String	getIdProvided() Gets the value of idProvided.
String	getIdVerified() Gets the value of idVerified.
String	getLastName() Gets the value of lastName.
String	getMajor() Gets the value of major.
Boolean	getMedicalStaffFlag() Gets the value of medicalStaff.
String	getMiddleName() Gets the value of middleName.
String	getMobilePhoneNumber() Gets the value of mobilePhoneNumber.
String	getOfficeLocation() Gets the value of officeLocation.
String	getOfficePhone() Gets the value of officePhone.
Boolean	getOnSabbaticalFlag() Gets the value of onSabbatical.
String	getOrganizationIdentifier() This method returns the contact's associated unit number.
Boolean	getOtherAcademicGroupFlag() Gets the value of otherAcademicGroup.
String	getPagerNumber() Gets the value of pagerNumber.
String	getPersonId() Gets the person id which is the KIM principal id.
String	getPhoneNumber() This method returns the contact's phone number.
String	getPostalCode() Gets the value of postalCode.
String	getPrimaryTitle() Gets the value of primaryTitle.
String	getPriorName() Gets the value of priorName.
String	getRace() Gets the value of race.
Boolean	getResearchStaffFlag() Gets the value of researchStaff.
String	getSaluation() Gets the value of saluation.
String	getSchool() Gets the value of school.
String	getSecondaryOfficeLocation() Gets the value of secondaryOfficeLocation.
String	getSecondaryOfficePhone() Gets the value of secondaryOfficePhone.
Boolean	getServiceStaffFlag() Gets the value of serviceStaff.
String	getSocialSecurityNumber() Gets the value of socialSecurityNumber.
String	getState() Gets the value of state.
Boolean	getSupportStaffFlag() Gets the value of supportStaff.
Unit	getUnit() This method returns the associated unit
String	getUserName() Gets the value of userName.
Boolean	getVacationAccrualFlag() Gets the value of vacationAccrual.
Boolean	getVeteranFlag() Gets the value of veteran.
String	getVeteranType() Gets the value of veteranType.
String	getVisaCode() Gets the value of visaCode.
String	getVisaRenewalDate() Gets the value of visaRenewalDate.
String	getVisaType() Gets the value of visaType.
String	getYearGraduated() Gets the value of yearGraduated.
void	prepareForWorkflow()
void	refresh()
void	setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService boService)
void	setIdentityService(org.kuali.rice.kim.api.identity.IdentityService identityService)
void	setPersonId(String personId) Sets the person id which is the KIM principal id.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

KcPerson

public KcPerson()

When using this ctor setPersonId(String) must be call else this call is in an invalid state.

Method Detail

fromPersonId

public static KcPerson fromPersonId(String personId)

Creates a KcPerson from a principal id.

Parameters:

personId - the principal id in KIM

Returns:

a KcPerson instance

Throws:

IllegalArgumentException - if the personId is empty

fromExtendedAttributes

public static KcPerson fromExtendedAttributes(KcPersonExtendedAttributes extendedAttributes)

Creates a KcPerson from an KcPersonExtendedAttributes BO.

Parameters:

extendedAttributes - the KC Person Extended Attributes.

Returns:

a KcPerson instance

Throws:

IllegalArgumentException - if the extendedAttributes is null or the extendedAttributes.personId is empty

fromEntityAndPersonId

public static KcPerson fromEntityAndPersonId(org.kuali.rice.kim.api.identity.entity.EntityContract entity,
                             String personId)

Creates a KcPerson from an EntityContract & principalId.

Parameters:

entity - the KIM entity.

personId - the principal id in KIM. This is needed b/c a KIM entity can have multiple principal. This determines which principal this wrapper will refer to.

Returns:

a KcPerson instance

Throws:

IllegalArgumentException - if the entity is null, principalId is empty, or if the entity does not contain a principal with the passed in principal id

fromEntityAndUserName

public static KcPerson fromEntityAndUserName(org.kuali.rice.kim.api.identity.entity.EntityContract entity,
                             String userName)

Creates a KcPerson from an EntityContract & principalId.

Parameters:

entity - the KIM entity.

userName - the principal's user name in KIM. This is needed b/c a KIM entity can have multiple principal. This determines which principal this wrapper will refer to.

Returns:

a KcPerson instance

Throws:

IllegalArgumentException - if the entity is null, userName is empty, or if the entity does not contain a principal with the passed in user name

refresh

public void refresh()

Specified by:

refresh in interface org.kuali.rice.krad.bo.BusinessObject

prepareForWorkflow

public void prepareForWorkflow()

getPersonId

public String getPersonId()

Gets the person id which is the KIM principal id.

Returns:

the person id

setPersonId

public void setPersonId(String personId)

Sets the person id which is the KIM principal id.

Parameters:

personId - the person id

getSocialSecurityNumber

public String getSocialSecurityNumber()

Gets the value of socialSecurityNumber.

Returns:

the value of socialSecurityNumber

getLastName

public String getLastName()

Gets the value of lastName.

Specified by:

getLastName in interface Contactable

Returns:

the value of lastName

getFirstName

public String getFirstName()

Gets the value of firstName.

Specified by:

getFirstName in interface Contactable

Returns:

the value of firstName

getMiddleName

public String getMiddleName()

Gets the value of middleName.

Returns:

the value of middleName

getFullName

public String getFullName()

Gets the value of fullName.

Specified by:

getFullName in interface Contactable

Returns:

the value of fullName

getPriorName

public String getPriorName()

Gets the value of priorName.

Returns:

the value of priorName

getUserName

public String getUserName()

Gets the value of userName.

Returns:

the value of userName

getEmailAddress

public String getEmailAddress()

Gets the value of emailAddress.

Specified by:

getEmailAddress in interface Contactable

Returns:

the value of emailAddress

getDateOfBirth

public String getDateOfBirth()

Gets the value of dateOfBirth.

Returns:

the value of dateOfBirth

getAge

public Integer getAge()

Gets the value of age. Will return null if not set.

Returns:

the value of age

getAgeByFiscalYear

public Integer getAgeByFiscalYear()

Gets the value of ageByFiscalYear. Will return null if not set.

Returns:

the value of ageByFiscalYear

getGender

public String getGender()

Gets the value of gender.

Returns:

the value of gender

getRace

public String getRace()

Gets the value of race.

Returns:

the value of race

getEducationLevel

public String getEducationLevel()

Gets the value of educationLevel.

Returns:

the value of educationLevel

getDegree

public String getDegree()

Gets the value of degree.

Returns:

the value of degree

getMajor

public String getMajor()

Gets the value of major.

Returns:

the value of major

getHandicappedFlag

public Boolean getHandicappedFlag()

Gets the value of handicapped.

Returns:

the value of handicapped

getHandicapType

public String getHandicapType()

Gets the value of handicapType.

Returns:

the value of handicapType

getVeteranFlag

public Boolean getVeteranFlag()

Gets the value of veteran.

Returns:

the value of veteran

getVeteranType

public String getVeteranType()

Gets the value of veteranType.

Returns:

the value of veteranType

getVisaCode

public String getVisaCode()

Gets the value of visaCode.

Returns:

the value of visaCode

getVisaType

public String getVisaType()

Gets the value of visaType.

Returns:

the value of visaType

getVisaRenewalDate

public String getVisaRenewalDate()

Gets the value of visaRenewalDate.

Returns:

the value of visaRenewalDate

getHasVisa

public Boolean getHasVisa()

Gets the value of hasVisa.

Returns:

the value of hasVisa

getOfficeLocation

public String getOfficeLocation()

Gets the value of officeLocation.

Returns:

the value of officeLocation

getOfficePhone

public String getOfficePhone()

Gets the value of officePhone.

Returns:

the value of officePhone

getSecondaryOfficeLocation

public String getSecondaryOfficeLocation()

Gets the value of secondaryOfficeLocation.

Returns:

the value of secondaryOfficeLocation

getSecondaryOfficePhone

public String getSecondaryOfficePhone()

Gets the value of secondaryOfficePhone.

Returns:

the value of secondaryOfficePhone

getSchool

public String getSchool()

Gets the value of school.

Returns:

the value of school

getYearGraduated

public String getYearGraduated()

Gets the value of yearGraduated.

Returns:

the value of yearGraduated

getDirectoryDepartment

public String getDirectoryDepartment()

Gets the value of directoryDepartment.

Returns:

the value of directoryDepartment

getSaluation

public String getSaluation()

Gets the value of saluation.

Returns:

the value of saluation

getCountryOfCitizenship

public String getCountryOfCitizenship()

Gets the value of countryOfCitizenship.

Returns:

the value of countryOfCitizenship

getPrimaryTitle

public String getPrimaryTitle()

Gets the value of primaryTitle.

Returns:

the value of primaryTitle

getDirectoryTitle

public String getDirectoryTitle()

Gets the value of directoryTitle.

Returns:

the value of directoryTitle

getFacultyFlag

public Boolean getFacultyFlag()

Gets the value of faculty.

Returns:

the value of faculty

getGraduateStudentStaffFlag

public Boolean getGraduateStudentStaffFlag()

Gets the value of graduateStudentStaff.

Returns:

the value of graduateStudentStaff

getResearchStaffFlag

public Boolean getResearchStaffFlag()

Gets the value of researchStaff.

Returns:

the value of researchStaff

getServiceStaffFlag

public Boolean getServiceStaffFlag()

Gets the value of serviceStaff.

Returns:

the value of serviceStaff

getSupportStaffFlag

public Boolean getSupportStaffFlag()

Gets the value of supportStaff.

Returns:

the value of supportStaff

getOtherAcademicGroupFlag

public Boolean getOtherAcademicGroupFlag()

Gets the value of otherAcademicGroup.

Returns:

the value of otherAcademicGroup

getMedicalStaffFlag

public Boolean getMedicalStaffFlag()

Gets the value of medicalStaff.

Returns:

the value of medicalStaff

getVacationAccrualFlag

public Boolean getVacationAccrualFlag()

Gets the value of vacationAccrual.

Returns:

the value of vacationAccrual

getOnSabbaticalFlag

public Boolean getOnSabbaticalFlag()

Gets the value of onSabbatical.

Returns:

the value of onSabbatical

getIdProvided

public String getIdProvided()

Gets the value of idProvided.

Returns:

the value of idProvided

getIdVerified

public String getIdVerified()

Gets the value of idVerified.

Returns:

the value of idVerified

getAddressLine1

public String getAddressLine1()

Gets the value of addressLine1.

Returns:

the value of addressLine1

getAddressLine2

public String getAddressLine2()

Gets the value of addressLine2.

Returns:

the value of addressLine2

getAddressLine3

public String getAddressLine3()

Gets the value of addressLine3.

Returns:

the value of addressLine3

getCity

public String getCity()

Gets the value of city.

Returns:

the value of city

getCounty

public String getCounty()

Gets the value of county.

Returns:

the value of county

getState

public String getState()

Gets the value of state.

Returns:

the value of state

getPostalCode

public String getPostalCode()

Gets the value of postalCode.

Returns:

the value of postalCode

getCountryCode

public String getCountryCode()

Gets the value of countryCode.

Returns:

the value of countryCode

getFaxNumber

public String getFaxNumber()

Gets the value of faxNumber.

Returns:

the value of faxNumber

getPagerNumber

public String getPagerNumber()

Gets the value of pagerNumber.

Returns:

the value of pagerNumber

getMobilePhoneNumber

public String getMobilePhoneNumber()

Gets the value of mobilePhoneNumber.

Returns:

the value of mobilePhoneNumber

getEraCommonsUserName

public String getEraCommonsUserName()

Gets the value of eraCommonsUserName.

Returns:

the value of eraCommonsUserName

getActive

public Boolean getActive()

Gets the active flag.

Returns:

the active flag

getIdentifier

public String getIdentifier()

This method returns the serializable identifier of the contact. May return null if no identifier has yet been assigned.

Specified by:

getIdentifier in interface Contactable

Returns:

getUnit

public Unit getUnit()

This method returns the associated unit

Specified by:

getUnit in interface Contactable

Returns:

getPhoneNumber

public String getPhoneNumber()

This method returns the contact's phone number. May return null.

Specified by:

getPhoneNumber in interface Contactable

Returns:

getContactOrganizationName

public String getContactOrganizationName()

This method returns the contact's organization name. May be the unit name or something different. Also, may return null.

Specified by:

getContactOrganizationName in interface Contactable

Returns:

getOrganizationIdentifier

public String getOrganizationIdentifier()

This method returns the contact's associated unit number. This is commonly referred to as homeUnit is many places in KC.

Specified by:

getOrganizationIdentifier in interface Contactable

Returns:

getCampusCode

public String getCampusCode()

Gets the campus code.

Returns:

the campus code

getExtendedAttributes

public KcPersonExtendedAttributes getExtendedAttributes()

gets the extended attributes BO. This is only here to make rice DD relationships work.

Returns:

the BO

toString

public String toString()

Specified by:

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

Overrides:

toString in class Object

setIdentityService

public void setIdentityService(org.kuali.rice.kim.api.identity.IdentityService identityService)

setBusinessObjectService

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