org.kuali.rice.kim.bo.entity.dto
Class KimEntityInfo

java.lang.Object
  org.kuali.rice.kim.bo.entity.dto.KimInactivatableInfo
      org.kuali.rice.kim.bo.entity.dto.KimEntityInfo

All Implemented Interfaces:

Serializable, KimEntity, Inactivateable

public class KimEntityInfo
extends KimInactivatableInfo
implements KimEntity

This is a data transfer object containing all information related to a KIM entity.

Author:

Kuali Rice Team (kuali-rice@googlegroups.com)

See Also:

Serialized Form

Field Summary

Fields inherited from class org.kuali.rice.kim.bo.entity.dto.KimInactivatableInfo

active

Constructor Summary

KimEntityInfo()
This constructs an empty KimEntityInfo

KimEntityInfo(KimEntity entity)
This constructs a KimEntityInfo derived from the KimEntity passed in.

Method Summary

List<KimEntityAffiliationInfo>	getAffiliations() Gets this KimEntity's affiliations
KimEntityBioDemographicsInfo	getBioDemographics() Gets this KimEntity's demographic information
List<KimEntityCitizenshipInfo>	getCitizenships() Gets this KimEntity's citizenship information
KimEntityAffiliationInfo	getDefaultAffiliation() Gets this KimEntity's default affiliation
KimEntityNameInfo	getDefaultName() Gets this KimEntity's default name
List<KimEntityEmploymentInformationInfo>	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<KimEntityEntityTypeInfo>	getEntityTypes() Gets this KimEntity's entity types
List<KimEntityEthnicityInfo>	getEthnicities() Gets this KimEntity's ethnicities
List<KimEntityExternalIdentifierInfo>	getExternalIdentifiers() Gets this KimEntity's external identifiers
List<KimEntityNameInfo>	getNames() Gets this KimEntity's names
KimEntityEmploymentInformationInfo	getPrimaryEmployment() Gets this KimEntity's employment information
List<KimPrincipalInfo>	getPrincipals() Gets this KimEntity's principals
KimEntityPrivacyPreferencesInfo	getPrivacyPreferences() Gets this KimEntity's privacy preferences
List<KimEntityResidencyInfo>	getResidencies() Gets this KimEntity's residencies
List<KimEntityVisaInfo>	getVisas() Gets this KimEntity's visas
void	setAffiliations(List<KimEntityAffiliationInfo> affiliations) Setter for this KimEntityInfo's affiliations.
void	setBioDemographics(KimEntityBioDemographicsInfo bioDemographics) Setter for this KimEntityInfo's demographic information.
void	setCitizenships(List<KimEntityCitizenshipInfo> citizenships) Setter for this KimEntityInfo's demographic information.
void	setEmploymentInformation(List<KimEntityEmploymentInformationInfo> employmentInformation) Setter for this KimEntityInfo's employment information.
void	setEntityId(String entityId) Setter for this KimEntityInfo's entity id.
void	setEntityTypes(List<KimEntityEntityTypeInfo> entityTypes) Setter for this KimEntityInfo's entity types.
void	setEthnicities(List<KimEntityEthnicityInfo> ethnicities) Setter for this KimEntityInfo's ethnicities.
void	setExternalIdentifiers(List<KimEntityExternalIdentifierInfo> externalIdentifiers) Setter for this KimEntityInfo's external identifiers.
void	setNames(List<KimEntityNameInfo> names) Setter for this KimEntityInfo's names.
void	setPrincipals(List<KimPrincipalInfo> principals) Setter for this KimEntityInfo's principals.
void	setPrivacyPreferences(KimEntityPrivacyPreferencesInfo privacyPreferences) Setter for this KimEntityInfo's privacy preferences.
void	setResidencies(List<KimEntityResidencyInfo> residencies) Setter for this KimEntityInfo's residencies.
void	setVisas(List<KimEntityVisaInfo> visas) Setter for this KimEntityInfo's visas.

Methods inherited from class org.kuali.rice.kim.bo.entity.dto.KimInactivatableInfo

isActive, setActive

Methods inherited from class java.lang.Object

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

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

isActive, setActive

Constructor Detail

KimEntityInfo

public KimEntityInfo()

This constructs an empty KimEntityInfo

KimEntityInfo

public KimEntityInfo(KimEntity entity)

This constructs a KimEntityInfo derived from the KimEntity passed in.

Parameters:

entity - the KimEntity that this KimEntityInfo is derived from. If null, then an empty KimEntityInfo will be constructed.

Method Detail

getAffiliations

public List<KimEntityAffiliationInfo> getAffiliations()

Gets this KimEntity's affiliations

Specified by:

getAffiliations in interface KimEntity

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.

See Also:

KimEntity.getAffiliations()

setAffiliations

public void setAffiliations(List<KimEntityAffiliationInfo> affiliations)

Setter for this KimEntityInfo's affiliations. Note the behavior of getAffiliations() if this is set to null;

getDefaultAffiliation

public KimEntityAffiliationInfo getDefaultAffiliation()

Gets this KimEntity's default affiliation

Specified by:

getDefaultAffiliation in interface KimEntity

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.

See Also:

KimEntity.getDefaultAffiliation()

getBioDemographics

public KimEntityBioDemographicsInfo getBioDemographics()

Gets this KimEntity's demographic information

Specified by:

getBioDemographics in interface KimEntity

Returns:

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

See Also:

KimEntity.getBioDemographics()

setBioDemographics

public void setBioDemographics(KimEntityBioDemographicsInfo bioDemographics)

Setter for this KimEntityInfo's demographic information. Note the behavior of getBioDemographics() if this is set to null;

getCitizenships

public List<KimEntityCitizenshipInfo> getCitizenships()

Gets this KimEntity's citizenship information

Specified by:

getCitizenships in interface KimEntity

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.

See Also:

KimEntity.getCitizenships()

setCitizenships

public void setCitizenships(List<KimEntityCitizenshipInfo> citizenships)

Setter for this KimEntityInfo's demographic information. Note the behavior of getCitizenships() if this is set to null;

getEmploymentInformation

public List<KimEntityEmploymentInformationInfo> getEmploymentInformation()

Gets this KimEntity's employment information List

Specified by:

getEmploymentInformation in interface KimEntity

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.

See Also:

KimEntity.getEmploymentInformation()

setEmploymentInformation

public void setEmploymentInformation(List<KimEntityEmploymentInformationInfo> employmentInformation)

Setter for this KimEntityInfo's employment information. Note the behavior of getEmploymentInformation() if this is set to null;

getPrimaryEmployment

public KimEntityEmploymentInformationInfo getPrimaryEmployment()

Gets this KimEntity's employment information

Specified by:

getPrimaryEmployment in interface KimEntity

Returns:

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

See Also:

KimEntity.getPrimaryEmployment()

getEntityId

public String getEntityId()

Gets this KimEntity's entity id.

Specified by:

getEntityId in interface KimEntity

Returns:

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

See Also:

KimEntity.getEntityId()

setEntityId

public void setEntityId(String entityId)

Setter for this KimEntityInfo's entity id. Note the behavior of getEntityId() if this is set to null;

getEntityTypes

public List<KimEntityEntityTypeInfo> getEntityTypes()

Gets this KimEntity's entity types

Specified by:

getEntityTypes in interface KimEntity

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.

See Also:

KimEntity.getEntityTypes()

setEntityTypes

public void setEntityTypes(List<KimEntityEntityTypeInfo> entityTypes)

Setter for this KimEntityInfo's entity types. Note the behavior of getEntityTypes() if this is set to null;

getExternalIdentifiers

public List<KimEntityExternalIdentifierInfo> getExternalIdentifiers()

Gets this KimEntity's external identifiers

Specified by:

getExternalIdentifiers in interface KimEntity

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.

See Also:

KimEntity.getExternalIdentifiers()

setExternalIdentifiers

public void setExternalIdentifiers(List<KimEntityExternalIdentifierInfo> externalIdentifiers)

Setter for this KimEntityInfo's external identifiers. Note the behavior of getExternalIdentifiers() if this is set to null;

getNames

public List<KimEntityNameInfo> getNames()

Gets this KimEntity's names

Specified by:

getNames in interface KimEntity

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.

See Also:

KimEntity.getNames()

setNames

public void setNames(List<KimEntityNameInfo> names)

Setter for this KimEntityInfo's names. Note the behavior of getNames() if this is set to null;

getDefaultName

public KimEntityNameInfo getDefaultName()

Gets this KimEntity's default name

Specified by:

getDefaultName in interface KimEntity

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.

See Also:

KimEntity.getDefaultName()

getPrincipals

public List<KimPrincipalInfo> getPrincipals()

Gets this KimEntity's principals

Specified by:

getPrincipals in interface KimEntity

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.

See Also:

KimEntity.getPrincipals()

setPrincipals

public void setPrincipals(List<KimPrincipalInfo> principals)

Setter for this KimEntityInfo's principals. Note the behavior of getPrincipals() if this is set to null;

getPrivacyPreferences

public KimEntityPrivacyPreferencesInfo getPrivacyPreferences()

Gets this KimEntity's privacy preferences

Specified by:

getPrivacyPreferences in interface KimEntity

Returns:

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

See Also:

KimEntity.getPrivacyPreferences()

setPrivacyPreferences

public void setPrivacyPreferences(KimEntityPrivacyPreferencesInfo privacyPreferences)

Setter for this KimEntityInfo's privacy preferences. Note the behavior of getPrivacyPreferences() if this is set to null;

getEthnicities

public List<KimEntityEthnicityInfo> getEthnicities()

Gets this KimEntity's ethnicities

Specified by:

getEthnicities in interface KimEntity

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.

See Also:

KimEntity.getEthnicities()

setEthnicities

public void setEthnicities(List<KimEntityEthnicityInfo> ethnicities)

Setter for this KimEntityInfo's ethnicities. Note the behavior of getEthnicities() if this is set to null;

getResidencies

public List<KimEntityResidencyInfo> getResidencies()

Gets this KimEntity's residencies

Specified by:

getResidencies in interface KimEntity

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.

See Also:

KimEntity.getResidencies()

setResidencies

public void setResidencies(List<KimEntityResidencyInfo> residencies)

Setter for this KimEntityInfo's residencies. Note the behavior of getResidencies() if this is set to null;

getVisas

public List<KimEntityVisaInfo> getVisas()

Gets this KimEntity's visas

Specified by:

getVisas in interface KimEntity

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.

See Also:

KimEntity.getVisas()

setVisas

public void setVisas(List<KimEntityVisaInfo> visas)

Setter for this KimEntityInfo's visas. Note the behavior of getVisas() if this is set to null;

getEntityExternalIdentifier

public KimEntityExternalIdentifier getEntityExternalIdentifier(String externalIdentifierTypeCode)

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

Specified by:

getEntityExternalIdentifier in interface KimEntity

Parameters:

externalIdentifierTypeCode - the type code

Returns:

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

See Also:

KimEntity.getEntityExternalIdentifier(String)

getEntityType

public KimEntityEntityType getEntityType(String entityTypeCode)

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

Specified by:

getEntityType in interface KimEntity

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.

See Also:

KimEntity.getEntityType(String)