org.kuali.rice.kim.api.identity

Interface Person

All Superinterfaces:

BusinessObject, ExternalizableBusinessObject, ModelObjectBasic, Serializable

All Known Implementing Classes:

PersonImpl

public interface Person
extends ExternalizableBusinessObject

Person object for use by the KNS and KNS-based applications. This provides an abstraction layer between application code and the KIM objects to simplify use.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Method Summary

Methods

Modifier and Type	Method and Description
String	getAddressCity() Returns the city name from the default address for the Person.
String	getAddressCityUnmasked()
String	getAddressCountryCode() Returns the country code from the default address for the Person.
String	getAddressCountryCodeUnmasked()
String	getAddressLine1() Returns line1 of the default address for the Person.
String	getAddressLine1Unmasked()
String	getAddressLine2() Returns line2 of the default address for the Person.
String	getAddressLine2Unmasked()
String	getAddressLine3() Returns line3 of the default address for the Person.
String	getAddressLine3Unmasked()
String	getAddressPostalCode() Returns the postal code from the default address for the Person.
String	getAddressPostalCodeUnmasked()
String	getAddressStateProvinceCode() Returns the state code from the default address for the Person.
String	getAddressStateProvinceCodeUnmasked()
KualiDecimal	getBaseSalaryAmount()
String	getCampusCode()
List<String>	getCampusCodesForAffiliationOfType(String affiliationTypeCode)
String	getEmailAddress()
String	getEmailAddressUnmasked()
String	getEmployeeId()
String	getEmployeeStatusCode()
String	getEmployeeTypeCode()
String	getEntityId()
String	getEntityTypeCode()
String	getExternalId(String externalIdentifierTypeCode)
Map<String,String>	getExternalIdentifiers()
String	getFirstName() The first name from the default name record for the entity.
String	getFirstNameUnmasked()
String	getLastName()
String	getLastNameUnmasked()
String	getMiddleName()
String	getMiddleNameUnmasked()
String	getName()
String	getNameUnmasked()
String	getPhoneNumber() Returns the default phone number for the entity.
String	getPhoneNumberUnmasked()
String	getPrimaryDepartmentCode()
String	getPrincipalId()
String	getPrincipalName()
boolean	hasAffiliationOfType(String affiliationTypeCode) Checks whether the person has an affiliation of a particular type: staff/faculty/student/etc...
boolean	isActive()

Methods inherited from interface org.kuali.rice.krad.bo.BusinessObject

refresh

Methods inherited from interface org.kuali.rice.core.api.mo.ModelObjectBasic

toString

Method Detail

getPrincipalId

String getPrincipalId()

getPrincipalName

String getPrincipalName()

getEntityId

String getEntityId()

getEntityTypeCode

String getEntityTypeCode()

getFirstName

String getFirstName()

The first name from the default name record for the entity.

getFirstNameUnmasked

String getFirstNameUnmasked()

getMiddleName

String getMiddleName()

getMiddleNameUnmasked

String getMiddleNameUnmasked()

getLastName

String getLastName()

getLastNameUnmasked

String getLastNameUnmasked()

getName

String getName()

getNameUnmasked

String getNameUnmasked()

getEmailAddress

String getEmailAddress()

getEmailAddressUnmasked

String getEmailAddressUnmasked()

getAddressLine1

String getAddressLine1()

Returns line1 of the default address for the Person. Will lazy-load the information from the IdentityManagementService if requested.

getAddressLine1Unmasked

String getAddressLine1Unmasked()

getAddressLine2

String getAddressLine2()

Returns line2 of the default address for the Person. Will lazy-load the information from the IdentityManagementService if requested.

getAddressLine2Unmasked

String getAddressLine2Unmasked()

getAddressLine3

String getAddressLine3()

Returns line3 of the default address for the Person. Will lazy-load the information from the IdentityManagementService if requested.

getAddressLine3Unmasked

String getAddressLine3Unmasked()

getAddressCity

String getAddressCity()

Returns the city name from the default address for the Person. Will lazy-load the information from the IdentityManagementService if requested.

getAddressCityUnmasked

String getAddressCityUnmasked()

getAddressStateProvinceCode

String getAddressStateProvinceCode()

Returns the state code from the default address for the Person. Will lazy-load the information from the IdentityManagementService if requested.

getAddressStateProvinceCodeUnmasked

String getAddressStateProvinceCodeUnmasked()

getAddressPostalCode

String getAddressPostalCode()

Returns the postal code from the default address for the Person. Will lazy-load the information from the IdentityManagementService if requested.

getAddressPostalCodeUnmasked

String getAddressPostalCodeUnmasked()

getAddressCountryCode

String getAddressCountryCode()

Returns the country code from the default address for the Person. Will lazy-load the information from the IdentityManagementService if requested.

getAddressCountryCodeUnmasked

String getAddressCountryCodeUnmasked()

getPhoneNumber

String getPhoneNumber()

Returns the default phone number for the entity.

getPhoneNumberUnmasked

String getPhoneNumberUnmasked()

getCampusCode

String getCampusCode()

getExternalIdentifiers

Map<String,String> getExternalIdentifiers()

hasAffiliationOfType

boolean hasAffiliationOfType(String affiliationTypeCode)

Checks whether the person has an affiliation of a particular type: staff/faculty/student/etc...

getCampusCodesForAffiliationOfType

List<String> getCampusCodesForAffiliationOfType(String affiliationTypeCode)

getEmployeeStatusCode

String getEmployeeStatusCode()

getEmployeeTypeCode

String getEmployeeTypeCode()

getBaseSalaryAmount

KualiDecimal getBaseSalaryAmount()

getExternalId

String getExternalId(String externalIdentifierTypeCode)

getPrimaryDepartmentCode

String getPrimaryDepartmentCode()

getEmployeeId

String getEmployeeId()

isActive

boolean isActive()