Package org.kuali.rice.kim.api.identity.entity

Interface EntityContract

All Superinterfaces:

org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Identifiable, org.kuali.rice.core.api.mo.common.active.Inactivatable, org.kuali.rice.core.api.mo.common.Versioned

All Known Implementing Classes:

Entity, Entity.Builder

public interface EntityContract
extends org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.active.Inactivatable, org.kuali.rice.core.api.mo.common.Identifiable

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

Author:

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

Method Summary

Modifier and Type	Method	Description
List<? extends EntityAffiliationContract>	getAffiliations()	Gets this EntityContract's affiliations
EntityBioDemographicsContract	getBioDemographics()	Gets this EntityContract's demographic information
List<? extends EntityCitizenshipContract>	getCitizenships()	Gets this EntityContract's citizenship information
EntityAffiliationContract	getDefaultAffiliation()	Gets this EntityContract's default affiliation
EntityNameContract	getDefaultName()	Gets this EntityContract's default name
List<? extends EntityEmploymentContract>	getEmploymentInformation()	Gets this EntityContract's employment information List
EntityExternalIdentifierContract	getEntityExternalIdentifier(String externalIdentifierTypeCode)	Gets this EntityContract's external identifier for the given type code
EntityTypeContactInfoContract	getEntityTypeContactInfoByTypeCode(String entityTypeCode)	Gets this EntityContract's identity type for the given type code
List<? extends EntityTypeContactInfoContract>	getEntityTypeContactInfos()	Gets this EntityContract's identity types
List<? extends EntityEthnicityContract>	getEthnicities()	Gets this EntityContract's ethnicities
List<? extends EntityExternalIdentifierContract>	getExternalIdentifiers()	Gets this EntityContract's external identifiers
List<? extends EntityNameContract>	getNames()	Gets this EntityContract's names
EntityEmploymentContract	getPrimaryEmployment()	Gets this EntityContract's employment information
List<? extends PrincipalContract>	getPrincipals()	Gets this EntityContract's principals
EntityPrivacyPreferencesContract	getPrivacyPreferences()	Gets this EntityContract's privacy preferences
List<? extends EntityResidencyContract>	getResidencies()	Gets this EntityContract's residencies
List<? extends EntityVisaContract>	getVisas()	Gets this EntityContract's visas

Methods inherited from interface org.kuali.rice.core.api.mo.common.GloballyUnique

getObjectId

Methods inherited from interface org.kuali.rice.core.api.mo.common.Identifiable

getId

Methods inherited from interface org.kuali.rice.core.api.mo.common.active.Inactivatable

isActive

Methods inherited from interface org.kuali.rice.core.api.mo.common.Versioned

getVersionNumber

Method Details

getEntityTypeContactInfos

List<? extends EntityTypeContactInfoContract> getEntityTypeContactInfos()

Gets this EntityContract's identity types

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.

getPrincipals

List<? extends PrincipalContract> getPrincipals()

Gets this EntityContract's principals

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.

getExternalIdentifiers

List<? extends EntityExternalIdentifierContract> getExternalIdentifiers()

Gets this EntityContract's external identifiers

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

List<? extends EntityAffiliationContract> getAffiliations()

Gets this EntityContract's affiliations

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

List<? extends EntityNameContract> getNames()

Gets this EntityContract's names

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

List<? extends EntityEmploymentContract> getEmploymentInformation()

Gets this EntityContract's employment information List

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

EntityPrivacyPreferencesContract getPrivacyPreferences()

Gets this EntityContract's privacy preferences

Returns:

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

getBioDemographics

EntityBioDemographicsContract getBioDemographics()

Gets this EntityContract's demographic information

Returns:

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

getCitizenships

List<? extends EntityCitizenshipContract> getCitizenships()

Gets this EntityContract's citizenship information

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.

getEntityTypeContactInfoByTypeCode

EntityTypeContactInfoContract getEntityTypeContactInfoByTypeCode(String entityTypeCode)

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

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.

getPrimaryEmployment

EntityEmploymentContract getPrimaryEmployment()

Gets this EntityContract's employment information

Returns:

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

getDefaultAffiliation

EntityAffiliationContract getDefaultAffiliation()

Gets this EntityContract's default affiliation

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

EntityExternalIdentifierContract getEntityExternalIdentifier(String externalIdentifierTypeCode)

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

Parameters:

externalIdentifierTypeCode - the type code

Returns:

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

getDefaultName

EntityNameContract getDefaultName()

Gets this EntityContract's default name

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

List<? extends EntityEthnicityContract> getEthnicities()

Gets this EntityContract's ethnicities

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

List<? extends EntityResidencyContract> getResidencies()

Gets this EntityContract's residencies

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

List<? extends EntityVisaContract> getVisas()

Gets this EntityContract's visas

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.