org.kuali.rice.kim.bo.entity
Interface KimEntity

All Superinterfaces:

Inactivateable

All Known Implementing Classes:

KimEntityImpl, KimEntityInfo

public interface KimEntity
extends Inactivateable

Represents an Entity (person/vendor/system) within the Rice system.

Author:

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

Method Summary

List<? extends KimEntityAffiliation>	getAffiliations() Gets this KimEntity's affiliations
KimEntityBioDemographics	getBioDemographics() Gets this KimEntity's demographic information
List<? extends KimEntityCitizenship>	getCitizenships() Gets this KimEntity's citizenship information
KimEntityAffiliation	getDefaultAffiliation() Gets this KimEntity's default affiliation
KimEntityName	getDefaultName() Gets this KimEntity's default name
List<? extends KimEntityEmploymentInformation>	getEmploymentInformation() Gets this KimEntity's employment information List
KimEntityExternalIdentifier	getEntityExternalIdentifier(String externalIdentifierTypeCode) Gets this KimEntity's external identifier for the given type code
String	getEntityId() Gets this KimEntity's entity id.
KimEntityEntityType	getEntityType(String entityTypeCode) Gets this KimEntity's entity type for the given type code
List<? extends KimEntityEntityType>	getEntityTypes() Gets this KimEntity's entity types
List<? extends KimEntityEthnicity>	getEthnicities() Gets this KimEntity's ethnicities
List<? extends KimEntityExternalIdentifier>	getExternalIdentifiers() Gets this KimEntity's external identifiers
List<? extends KimEntityName>	getNames() Gets this KimEntity's names
KimEntityEmploymentInformation	getPrimaryEmployment() Gets this KimEntity's employment information
List<? extends KimPrincipal>	getPrincipals() Gets this KimEntity's principals
KimEntityPrivacyPreferences	getPrivacyPreferences() Gets this KimEntity's privacy preferences
List<? extends KimEntityResidency>	getResidencies() Gets this KimEntity's residencies
List<? extends KimEntityVisa>	getVisas() Gets this KimEntity's visas

Methods inherited from interface org.kuali.rice.kns.bo.Inactivateable

isActive, setActive

Method Detail

getEntityId

String getEntityId()

Gets this KimEntity's entity id.

Returns:

the id for this KimEntity, or null if none has been assigned.

getEntityTypes

List<? extends KimEntityEntityType> getEntityTypes()

Gets this KimEntity's entity types

Returns:

the List of KimEntityEntityTypeS for this KimEntity. The returned List will never be null, an empty List will be assigned and returned if needed.

getPrincipals

List<? extends KimPrincipal> getPrincipals()

Gets this KimEntity's principals

Returns:

the List of KimPrincipalS for this KimEntity. The returned List will never be null, an empty List will be assigned and returned if needed.

getExternalIdentifiers

List<? extends KimEntityExternalIdentifier> getExternalIdentifiers()

Gets this KimEntity's external identifiers

Returns:

the List of KimEntityExternalIdentifierS for this KimEntity. The returned List will never be null, an empty List will be assigned and returned if needed.

getAffiliations

List<? extends KimEntityAffiliation> getAffiliations()

Gets this KimEntity's affiliations

Returns:

the List of KimEntityAffiliationS for this KimEntity. The returned List will never be null, an empty List will be assigned and returned if needed.

getNames

List<? extends KimEntityName> getNames()

Gets this KimEntity's names

Returns:

the List of KimEntityNameS for this KimEntity. The returned List will never be null, an empty List will be assigned and returned if needed.

getEmploymentInformation

List<? extends KimEntityEmploymentInformation> getEmploymentInformation()

Gets this KimEntity's employment information List

Returns:

the List of KimEntityEmploymentInformationS for this KimEntity. The returned List will never be null, an empty List will be assigned and returned if needed.

getPrivacyPreferences

KimEntityPrivacyPreferences getPrivacyPreferences()

Gets this KimEntity's privacy preferences

Returns:

the KimEntityPrivacyPreferences for this KimEntity, or null if none has been assigned.

getBioDemographics

KimEntityBioDemographics getBioDemographics()

Gets this KimEntity's demographic information

Returns:

the KimEntityBioDemographics for this KimEntity, or null if none has been assigned.

getCitizenships

List<? extends KimEntityCitizenship> getCitizenships()

Gets this KimEntity's citizenship information

Returns:

the List of KimEntityCitizenshipS for this KimEntity. The returned List will never be null, an empty List will be assigned and returned if needed.

getEntityType

KimEntityEntityType getEntityType(String entityTypeCode)

Gets this KimEntity's entity type for the given type code

Parameters:

entityTypeCode - the type code

Returns:

the EntityEntityType object corresponding to the given code or null if this entity does not have data for that type.

getPrimaryEmployment

KimEntityEmploymentInformation getPrimaryEmployment()

Gets this KimEntity's employment information

Returns:

the primary KimEntityEmploymentInformation for this KimEntity, or null if none has been assigned.

getDefaultAffiliation

KimEntityAffiliation getDefaultAffiliation()

Gets this KimEntity's default affiliation

Returns:

the default KimEntityAffiliation for the entity. If no default is defined, then it returns the first one found. If none are defined, it returns null.

getEntityExternalIdentifier

KimEntityExternalIdentifier getEntityExternalIdentifier(String externalIdentifierTypeCode)

Gets this KimEntity's external identifier for the given type code

Parameters:

externalIdentifierTypeCode - the type code

Returns:

the KimEntityExternalIdentifier for this KimEntity, or null if none has been assigned.

getDefaultName

KimEntityName getDefaultName()

Gets this KimEntity's default name

Returns:

the default KimEntityName record for the entity. If no default is defined, then it returns the first one found. If none are defined, it returns null.

getEthnicities

List<? extends KimEntityEthnicity> getEthnicities()

Gets this KimEntity's ethnicities

Returns:

the List of KimEntityEthnicityS for this KimEntity. The returned List will never be null, an empty List will be assigned and returned if needed.

getResidencies

List<? extends KimEntityResidency> getResidencies()

Gets this KimEntity's residencies

Returns:

the List of KimEntityResidencyS for this KimEntity. The returned List will never be null, an empty List will be assigned and returned if needed.

getVisas

List<? extends KimEntityVisa> getVisas()

Gets this KimEntity's visas

Returns:

the List of KimEntityVisaS for this KimEntity. The returned List will never be null, an empty List will be assigned and returned if needed.