EntityBo (Rice 2.5.3-SNAPSHOT API)

java.lang.Object
- org.kuali.rice.krad.bo.DataObjectBase
- - org.kuali.rice.kim.impl.identity.entity.EntityBo

All Implemented Interfaces:

Serializable, Inactivatable, GloballyUnique, Identifiable, Versioned, EntityContract
```
@Entity
public class EntityBo
extends DataObjectBase
implements EntityContract
```
See Also:
Serialized Form

Field Summary
- Fields inherited from class org.kuali.rice.krad.bo.DataObjectBase
  objectId, versionNumber

Constructor Summary

Constructors
Constructor and Description

EntityBo()

Constructors
Constructor and Description
`EntityBo()`

Method Summary

Methods
Modifier and Type	Method and Description
`static EntityBo`	`from(Entity immutable)`
`static EntityBo`	`fromAndUpdate(Entity immutable, EntityBo toUpdate)` Creates a EntityBo business object from an immutable representation of a Entity.
`boolean`	`getActive()`
`List<EntityAffiliationBo>`	`getAffiliations()` Gets this `EntityContract`'s affiliations
`EntityBioDemographicsBo`	`getBioDemographics()` Gets this `EntityContract`'s demographic information
`List<EntityCitizenshipBo>`	`getCitizenships()` Gets this `EntityContract`'s citizenship information
`EntityAffiliationBo`	`getDefaultAffiliation()` Gets this `EntityContract`'s default affiliation
`EntityNameContract`	`getDefaultName()` Gets this `EntityContract`'s default name
`List<EntityEmploymentBo>`	`getEmploymentInformation()` Gets this `EntityContract`'s employment information List
`EntityExternalIdentifierBo`	`getEntityExternalIdentifier(String externalIdentifierTypeCode)` Gets this `EntityContract`'s external identifier for the given type code
`EntityTypeContactInfoBo`	`getEntityTypeContactInfoByTypeCode(String entityTypeCode)` Gets this `EntityContract`'s identity type for the given type code
`List<EntityTypeContactInfoBo>`	`getEntityTypeContactInfos()` Gets this `EntityContract`'s identity types
`List<EntityEthnicityBo>`	`getEthnicities()` Gets this `EntityContract`'s ethnicities
`List<EntityExternalIdentifierBo>`	`getExternalIdentifiers()` Gets this `EntityContract`'s external identifiers
`String`	`getId()` The unique identifier for an object.
`List<EntityNameBo>`	`getNames()` Gets this `EntityContract`'s names
`EntityEmploymentBo`	`getPrimaryEmployment()` Gets this `EntityContract`'s employment information
`List<PrincipalBo>`	`getPrincipals()` Gets this `EntityContract`'s principals
`EntityPrivacyPreferencesBo`	`getPrivacyPreferences()` Gets this `EntityContract`'s privacy preferences
`List<EntityResidencyBo>`	`getResidencies()` Gets this `EntityContract`'s residencies
`List<EntityVisaBo>`	`getVisas()` Gets this `EntityContract`'s visas
`boolean`	`isActive()` The active indicator for an object.
`void`	`setActive(boolean active)`
`void`	`setAffiliations(List<EntityAffiliationBo> affiliations)`
`void`	`setBioDemographics(EntityBioDemographicsBo bioDemographics)`
`void`	`setCitizenships(List<EntityCitizenshipBo> citizenships)`
`void`	`setEmploymentInformation(List<EntityEmploymentBo> employmentInformation)`
`void`	`setEntityTypeContactInfos(List<EntityTypeContactInfoBo> entityTypeContactInfos)`
`void`	`setEthnicities(List<EntityEthnicityBo> ethnicities)`
`void`	`setExternalIdentifiers(List<EntityExternalIdentifierBo> externalIdentifiers)`
`void`	`setId(String id)`
`void`	`setNames(List<EntityNameBo> names)`
`void`	`setPrincipals(List<PrincipalBo> principals)`
`void`	`setPrivacyPreferences(EntityPrivacyPreferencesBo privacyPreferences)`
`void`	`setResidencies(List<EntityResidencyBo> residencies)`
`void`	`setVisas(List<EntityVisaBo> visas)`
`static Entity`	`to(EntityBo bo)`
`static EntityDefault`	`toDefault(EntityBo bo)`

Methods inherited from class org.kuali.rice.krad.bo.DataObjectBase
generateAndSetObjectIdIfNeeded, getExtensionObject, getObjectId, getVersionNumber, prePersist, preUpdate, setExtensionObject, setObjectId, setVersionNumber, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

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

- Constructor Detail
  - EntityBo
```
public EntityBo()
```
- Method Detail
  - to
```
public static Entity to(EntityBo bo)
```
  - toDefault
```
public static EntityDefault toDefault(EntityBo bo)
```
  - from
```
public static EntityBo from(Entity immutable)
```
  - fromAndUpdate
```
public static EntityBo fromAndUpdate(Entity immutable,
                     EntityBo toUpdate)
```
    Creates a EntityBo business object from an immutable representation of a Entity.
    
    Parameters:
    immutable - an immutable Entity
    
    Returns:
    a EntityBo
  - getEntityTypeContactInfoByTypeCode
```
public EntityTypeContactInfoBo 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.
  - getPrimaryEmployment
```
public EntityEmploymentBo 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 EntityAffiliationBo 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 EntityExternalIdentifierBo 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.
  - getPrivacyPreferences
```
public EntityPrivacyPreferencesBo 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 EntityBioDemographicsBo 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.
  - 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
  - setId
```
public void setId(String id)
```
  - getNames
```
public List<EntityNameBo> 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.
  - setNames
```
public void setNames(List<EntityNameBo> names)
```
  - getPrincipals
```
public List<PrincipalBo> 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.
  - setPrincipals
```
public void setPrincipals(List<PrincipalBo> principals)
```
  - getExternalIdentifiers
```
public List<EntityExternalIdentifierBo> 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.
  - setExternalIdentifiers
```
public void setExternalIdentifiers(List<EntityExternalIdentifierBo> externalIdentifiers)
```
  - getAffiliations
```
public List<EntityAffiliationBo> 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.
  - setAffiliations
```
public void setAffiliations(List<EntityAffiliationBo> affiliations)
```
  - getEmploymentInformation
```
public List<EntityEmploymentBo> 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.
  - setEmploymentInformation
```
public void setEmploymentInformation(List<EntityEmploymentBo> employmentInformation)
```
  - getEntityTypeContactInfos
```
public List<EntityTypeContactInfoBo> 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.
  - setEntityTypeContactInfos
```
public void setEntityTypeContactInfos(List<EntityTypeContactInfoBo> entityTypeContactInfos)
```
  - setPrivacyPreferences
```
public void setPrivacyPreferences(EntityPrivacyPreferencesBo privacyPreferences)
```
  - setBioDemographics
```
public void setBioDemographics(EntityBioDemographicsBo bioDemographics)
```
  - getCitizenships
```
public List<EntityCitizenshipBo> 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.
  - setCitizenships
```
public void setCitizenships(List<EntityCitizenshipBo> citizenships)
```
  - getEthnicities
```
public List<EntityEthnicityBo> 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.
  - setEthnicities
```
public void setEthnicities(List<EntityEthnicityBo> ethnicities)
```
  - getResidencies
```
public List<EntityResidencyBo> 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.
  - setResidencies
```
public void setResidencies(List<EntityResidencyBo> residencies)
```
  - getVisas
```
public List<EntityVisaBo> 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.
  - setVisas
```
public void setVisas(List<EntityVisaBo> visas)
```
  - getActive
```
public boolean getActive()
```
  - 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.
  - setActive
```
public void setActive(boolean active)
```

Class EntityBo

Field Summary

Fields inherited from class org.kuali.rice.krad.bo.DataObjectBase

Constructor Summary

Method Summary

Methods inherited from class org.kuali.rice.krad.bo.DataObjectBase

Methods inherited from class java.lang.Object

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

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

Constructor Detail

EntityBo

Method Detail

to

toDefault

from

fromAndUpdate

getEntityTypeContactInfoByTypeCode

getPrimaryEmployment

getDefaultAffiliation

getEntityExternalIdentifier

getDefaultName

getPrivacyPreferences

getBioDemographics

getId

setId

getNames

setNames

getPrincipals

setPrincipals

getExternalIdentifiers

setExternalIdentifiers

getAffiliations

setAffiliations

getEmploymentInformation

setEmploymentInformation

getEntityTypeContactInfos

setEntityTypeContactInfos

setPrivacyPreferences

setBioDemographics

getCitizenships

setCitizenships

getEthnicities

setEthnicities

getResidencies

setResidencies

getVisas

setVisas

getActive

isActive

setActive