org.kuali.rice.kim.api.identity.entity
Class Entity

java.lang.Object
  org.kuali.rice.core.api.mo.AbstractDataTransferObject
      org.kuali.rice.kim.api.identity.entity.Entity

All Implemented Interfaces:

Serializable, Inactivatable, GloballyUnique, Identifiable, Versioned, ModelObjectBasic, ModelObjectComplete, EntityContract

public final class Entity
extends AbstractDataTransferObject
implements EntityContract

See Also:

Serialized Form

Nested Class Summary

static class	Entity.Builder A builder which can be used to construct Entity instances.
static class	Entity.Cache

Method Summary

List<EntityAffiliation>	getAffiliations() Gets this EntityContract's affiliations
EntityBioDemographics	getBioDemographics() Gets this EntityContract's demographic information
List<EntityCitizenship>	getCitizenships() Gets this EntityContract's citizenship information
EntityAffiliation	getDefaultAffiliation() Gets this EntityContract's default affiliation
EntityNameContract	getDefaultName() Gets this EntityContract's default name
List<EntityEmployment>	getEmploymentInformation() Gets this EntityContract's employment information List
EntityExternalIdentifier	getEntityExternalIdentifier(String externalIdentifierTypeCode) Gets this EntityContract's external identifier for the given type code
EntityTypeContactInfo	getEntityTypeContactInfoByTypeCode(String entityTypeCode) Gets this EntityContract's identity type for the given type code
List<EntityTypeContactInfo>	getEntityTypeContactInfos() Gets this EntityContract's identity types
List<EntityEthnicity>	getEthnicities() Gets this EntityContract's ethnicities
List<EntityExternalIdentifier>	getExternalIdentifiers() Gets this EntityContract's external identifiers
String	getId() The unique identifier for an object.
List<EntityName>	getNames() Gets this EntityContract's names
String	getObjectId() Return the globally unique object id of this object.
EntityEmployment	getPrimaryEmployment() Gets this EntityContract's employment information
List<Principal>	getPrincipals() Gets this EntityContract's principals
EntityPrivacyPreferences	getPrivacyPreferences() Gets this EntityContract's privacy preferences
List<EntityResidency>	getResidencies() Gets this EntityContract's residencies
Long	getVersionNumber() Returns the version number for this object.
List<EntityVisa>	getVisas() Gets this EntityContract's visas
boolean	isActive() The active indicator for an object.

Methods inherited from class org.kuali.rice.core.api.mo.AbstractDataTransferObject

afterUnmarshal, beforeUnmarshal, equals, equalsExcludeFields, getDefaultHashCodeEqualsExcludeFields, hashCode, hashCodeExcludeFields, toString

Methods inherited from class java.lang.Object

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

Method Detail

getPrincipals

public List<Principal> getPrincipals()

Description copied from interface: EntityContract

Gets this EntityContract's principals

Specified by:

getPrincipals in interface EntityContract

Returns:

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

getEntityTypeContactInfos

public List<EntityTypeContactInfo> getEntityTypeContactInfos()

Description copied from interface: EntityContract

Gets this EntityContract's identity types

Specified by:

getEntityTypeContactInfos in interface EntityContract

Returns:

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

getExternalIdentifiers

public List<EntityExternalIdentifier> getExternalIdentifiers()

Description copied from interface: EntityContract

Gets this EntityContract's external identifiers

Specified by:

getExternalIdentifiers in interface EntityContract

Returns:

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

getAffiliations

public List<EntityAffiliation> getAffiliations()

Description copied from interface: EntityContract

Gets this EntityContract's affiliations

Specified by:

getAffiliations in interface EntityContract

Returns:

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

getNames

public List<EntityName> getNames()

Description copied from interface: EntityContract

Gets this EntityContract's names

Specified by:

getNames in interface EntityContract

Returns:

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

getEmploymentInformation

public List<EntityEmployment> getEmploymentInformation()

Description copied from interface: EntityContract

Gets this EntityContract's employment information List

Specified by:

getEmploymentInformation in interface EntityContract

Returns:

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

getPrivacyPreferences

public EntityPrivacyPreferences getPrivacyPreferences()

Description copied from interface: EntityContract

Gets this EntityContract's privacy preferences

Specified by:

getPrivacyPreferences in interface EntityContract

Returns:

the EntityPrivacyPreferences for this EntityContract, or null if none has been assigned.

getBioDemographics

public EntityBioDemographics getBioDemographics()

Description copied from interface: EntityContract

Gets this EntityContract's demographic information

Specified by:

getBioDemographics in interface EntityContract

Returns:

the EntityBioDemographicsContract for this EntityContract, or null if none has been assigned.

getCitizenships

public List<EntityCitizenship> getCitizenships()

Description copied from interface: EntityContract

Gets this EntityContract's citizenship information

Specified by:

getCitizenships in interface EntityContract

Returns:

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

getPrimaryEmployment

public EntityEmployment getPrimaryEmployment()

Description copied from interface: EntityContract

Gets this EntityContract's employment information

Specified by:

getPrimaryEmployment in interface EntityContract

Returns:

the primary EntityEmploymentContract for this EntityContract, or null if none has been assigned.

getDefaultAffiliation

public EntityAffiliation getDefaultAffiliation()

Description copied from interface: EntityContract

Gets this EntityContract's default affiliation

Specified by:

getDefaultAffiliation in interface EntityContract

Returns:

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

getEntityExternalIdentifier

public EntityExternalIdentifier getEntityExternalIdentifier(String externalIdentifierTypeCode)

Description copied from interface: EntityContract

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

Specified by:

getEntityExternalIdentifier in interface EntityContract

Parameters:

externalIdentifierTypeCode - the type code

Returns:

the EntityExternalIdentifierContract for this EntityContract, or null if none has been assigned.

getDefaultName

public EntityNameContract getDefaultName()

Description copied from interface: EntityContract

Gets this EntityContract's default name

Specified by:

getDefaultName in interface EntityContract

Returns:

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

getEthnicities

public List<EntityEthnicity> getEthnicities()

Description copied from interface: EntityContract

Gets this EntityContract's ethnicities

Specified by:

getEthnicities in interface EntityContract

Returns:

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

getResidencies

public List<EntityResidency> getResidencies()

Description copied from interface: EntityContract

Gets this EntityContract's residencies

Specified by:

getResidencies in interface EntityContract

Returns:

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

getVisas

public List<EntityVisa> getVisas()

Description copied from interface: EntityContract

Gets this EntityContract's visas

Specified by:

getVisas in interface EntityContract

Returns:

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

getVersionNumber

public Long getVersionNumber()

Description copied from interface: Versioned

Returns the version number for this object. In general, this value should only be null if the object has not yet been stored to a persistent data store. This version number is generally used for the purposes of optimistic locking.

Specified by:

getVersionNumber in interface Versioned

Returns:

the version number, or null if one has not been assigned yet

getObjectId

public String getObjectId()

Description copied from interface: GloballyUnique

Return the globally unique object id of this object. In general, this value should only be null if the object has not yet been stored to a persistent data store.

Specified by:

getObjectId in interface GloballyUnique

Returns:

the objectId of this object, or null if it has not been set yet

isActive

public boolean isActive()

Description copied from interface: Inactivatable

The active indicator for an object.

Specified by:

isActive in interface Inactivatable

Returns:

true if active false if not.

getId

public String getId()

Description copied from interface: Identifiable

The unique identifier for an object. This can be null.

Specified by:

getId in interface Identifiable

Returns:

the id

getEntityTypeContactInfoByTypeCode

public EntityTypeContactInfo getEntityTypeContactInfoByTypeCode(String entityTypeCode)

Description copied from interface: EntityContract

Gets this EntityContract's identity type for the given type code

Specified by:

getEntityTypeContactInfoByTypeCode in interface EntityContract

Parameters:

entityTypeCode - the type code

Returns:

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