EntityBioDemographicsContract (Rice 2.5.15 API)

All Superinterfaces:

GloballyUnique, Versioned

All Known Implementing Classes:

EntityBioDemographics, EntityBioDemographics.Builder, EntityBioDemographicsBo
```
public interface EntityBioDemographicsContract
extends Versioned, GloballyUnique
```
This is a contract for EntityBioDemographics and represents the demographic information of an Entity.

Author:

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

Field Summary

Fields
Modifier and Type Field and Description

static String BIRTH_DATE_FORMAT

static String DECEASED_DATE_FORMAT

Fields
Modifier and Type	Field and Description
`static String`	`BIRTH_DATE_FORMAT`
`static String`	`DECEASED_DATE_FORMAT`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Integer`	`getAge()` Gets this `EntityBioDemographicsContract`'s current age based on birth date if present.
`String`	`getBirthCity()` Gets this `EntityBioDemographicsContract`'s city of birth.
`String`	`getBirthCityUnmasked()` Gets this `EntityBioDemographicsContract`'s unmasked city of birth.
`String`	`getBirthCountry()` Gets this `EntityBioDemographicsContract`'s country of birth code.
`String`	`getBirthCountryUnmasked()` Gets this `EntityBioDemographicsContract`'s unmasked country of birth code.
`String`	`getBirthDate()` Gets this `EntityBioDemographicsContract`'s birth date.
`String`	`getBirthDateUnmasked()` Gets this `EntityBioDemographicsContract`'s unmasked birth date.
`String`	`getBirthStateProvinceCode()` Gets this `EntityBioDemographicsContract`'s birth state or extra-state jurisdiction code.
`String`	`getBirthStateProvinceCodeUnmasked()` Gets this `EntityBioDemographicsContract`'s unmasked birth state or extra-state jurisdiction code.
`String`	`getDeceasedDate()` Gets this `EntityBioDemographicsContract`'s deceased date.
`String`	`getEntityId()` Gets this `EntityBioDemographicsContract`'s identity id.
`String`	`getGenderChangeCode()` Get the `EntityBioDemographicsContract`'s gender change code Corresponds to PESC GenderChangeCode
`String`	`getGenderChangeCodeUnmasked()` Get the `EntityBioDemographicsContract`'s gender change code Corresponds to PESC GenderChangeCode
`String`	`getGenderCode()` Gets this `EntityBioDemographicsContract`'s gender code.
`String`	`getGenderCodeUnmasked()` Gets this `EntityBioDemographicsContract`'s unmasked gender code.
`String`	`getGeographicOrigin()` Gets this `EntityBioDemographicsContract`'s geographic origin.
`String`	`getGeographicOriginUnmasked()` Gets this `EntityBioDemographicsContract`'s unmasked geographic origin.
`String`	`getMaritalStatusCode()` Gets this `EntityBioDemographicsContract`'s marital status code.
`String`	`getMaritalStatusCodeUnmasked()` Gets this `EntityBioDemographicsContract`'s unmasked martial status code.
`String`	`getNoteMessage()` Get the note associated with this `EntityBioDemographicsContract` Corresponds to PESC NoteMessage
`String`	`getPrimaryLanguageCode()` Gets this `EntityBioDemographicsContract`'s primary language code.
`String`	`getPrimaryLanguageCodeUnmasked()` Gets this `EntityBioDemographicsContract`'s unmasked primary language code.
`String`	`getSecondaryLanguageCode()` Gets this `EntityBioDemographicsContract`'s secondary language code.
`String`	`getSecondaryLanguageCodeUnmasked()` Gets this `EntityBioDemographicsContract`'s unmasked secondary language code.
`boolean`	`isSuppressPersonal()` Returns a boolean value that determines if personal fields should be suppressed.

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

- Field Detail
  - BIRTH_DATE_FORMAT
```
static final String BIRTH_DATE_FORMAT
```
    See Also:
    
    Constant Field Values
  - DECEASED_DATE_FORMAT
```
static final String DECEASED_DATE_FORMAT
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getEntityId
```
String getEntityId()
```
    Gets this EntityBioDemographicsContract's identity id.
    
    Returns:
    
    the identity id for this EntityBioDemographicsContract, or null if none has been assigned.
  - getDeceasedDate
```
String getDeceasedDate()
```
    Gets this EntityBioDemographicsContract's deceased date.
    
    Returns:
    
    the deceased date for this EntityBioDemographicsContract, or null if none has been assigned.
  - getBirthDate
```
String getBirthDate()
```
    Gets this EntityBioDemographicsContract's birth date.
    
    Returns:
    
    the birth date for this EntityBioDemographicsContract, or null if none has been assigned.
  - getGenderCode
```
String getGenderCode()
```
    Gets this EntityBioDemographicsContract's gender code.
    
    Returns:
    
    the gender code for this EntityBioDemographicsContract, or null if none has been assigned.
  - getMaritalStatusCode
```
String getMaritalStatusCode()
```
    Gets this EntityBioDemographicsContract's marital status code.
    
    Returns:
    
    the marital status code for this EntityBioDemographicsContract, or null if none has been assigned.
  - getPrimaryLanguageCode
```
String getPrimaryLanguageCode()
```
    Gets this EntityBioDemographicsContract's primary language code.
    
    Returns:
    
    the primary language code for this EntityBioDemographicsContract, or null if none has been assigned.
  - getSecondaryLanguageCode
```
String getSecondaryLanguageCode()
```
    Gets this EntityBioDemographicsContract's secondary language code.
    
    Returns:
    
    the secondary language code for this EntityBioDemographicsContract, or null if none has been assigned.
  - getBirthCountry
```
String getBirthCountry()
```
    Gets this EntityBioDemographicsContract's country of birth code. Corresponds to PESC BirthCountry.
    
    Returns:
    
    the country of birth code for this EntityBioDemographicsContract, or null if none has been assigned.
  - getBirthStateProvinceCode
```
String getBirthStateProvinceCode()
```
    Gets this EntityBioDemographicsContract's birth state or extra-state jurisdiction code. Corresponds to PESC BirthStateProvinceCode.
    
    Returns:
    
    the birth state code for this EntityBioDemographicsContract, or null if none has been assigned.
  - getBirthCity
```
String getBirthCity()
```
    Gets this EntityBioDemographicsContract's city of birth. Corresponds to PESC BirthCity.
    
    Returns:
    
    the city of birth for this EntityBioDemographicsContract, or null if none has been assigned.
  - getGeographicOrigin
```
String getGeographicOrigin()
```
    Gets this EntityBioDemographicsContract's geographic origin.
    
    Returns:
    
    the geographic origin for this EntityBioDemographicsContract, or null if none has been assigned.
  - getBirthDateUnmasked
```
String getBirthDateUnmasked()
```
    Gets this EntityBioDemographicsContract's unmasked birth date.
    
    Returns:
    
    the unmasked birth date for this EntityBioDemographicsContract, or null if none has been assigned.
  - getAge
```
Integer getAge()
```
    Gets this EntityBioDemographicsContract's current age based on birth date if present. Age calculation uses deceased date if present.
    
    Returns:
    
    the calculated age for this EntityBioDemographicsContract, or null if getBirthDate() is unpresent, suppressed, or there is a calculation error.
  - getGenderCodeUnmasked
```
String getGenderCodeUnmasked()
```
    Gets this EntityBioDemographicsContract's unmasked gender code.
    
    Returns:
    
    the unmasked gender code for this EntityBioDemographicsContract, or null if none has been assigned.
  - getMaritalStatusCodeUnmasked
```
String getMaritalStatusCodeUnmasked()
```
    Gets this EntityBioDemographicsContract's unmasked martial status code.
    
    Returns:
    
    the unmasked martial status code for this EntityBioDemographicsContract, or null if none has been assigned.
  - getPrimaryLanguageCodeUnmasked
```
String getPrimaryLanguageCodeUnmasked()
```
    Gets this EntityBioDemographicsContract's unmasked primary language code.
    
    Returns:
    
    the unmasked primary language code for this EntityBioDemographicsContract, or null if none has been assigned.
  - getSecondaryLanguageCodeUnmasked
```
String getSecondaryLanguageCodeUnmasked()
```
    Gets this EntityBioDemographicsContract's unmasked secondary language code.
    
    Returns:
    
    the unmasked secondary language code for this EntityBioDemographicsContract, or null if none has been assigned.
  - getBirthCountryUnmasked
```
String getBirthCountryUnmasked()
```
    Gets this EntityBioDemographicsContract's unmasked country of birth code.
    
    Returns:
    
    the unmasked country of birth code for this EntityBioDemographicsContract, or null if none has been assigned.
  - getBirthStateProvinceCodeUnmasked
```
String getBirthStateProvinceCodeUnmasked()
```
    Gets this EntityBioDemographicsContract's unmasked birth state or extra-state jurisdiction code. Corresponds to PESC BirthStateProvinceCode.
    
    Returns:
    
    the unmaksed birth state code for this EntityBioDemographicsContract, or null if none has been assigned.
  - getBirthCityUnmasked
```
String getBirthCityUnmasked()
```
    Gets this EntityBioDemographicsContract's unmasked city of birth. Corresponds to PESC BirthCity.
    
    Returns:
    
    the unmasked city of birth for this EntityBioDemographicsContract, or null if none has been assigned.
  - getGeographicOriginUnmasked
```
String getGeographicOriginUnmasked()
```
    Gets this EntityBioDemographicsContract's unmasked geographic origin.
    
    Returns:
    
    the unmasked geographic origin for this EntityBioDemographicsContract, or null if none has been assigned.
  - getNoteMessage
```
String getNoteMessage()
```
    Get the note associated with this EntityBioDemographicsContract Corresponds to PESC NoteMessage
    
    Returns:
    
    the message associated with this EntityName
  - getGenderChangeCode
```
String getGenderChangeCode()
```
    Get the EntityBioDemographicsContract's gender change code Corresponds to PESC GenderChangeCode
    
    Returns:
    
    the gender change code or null if no change
  - getGenderChangeCodeUnmasked
```
String getGenderChangeCodeUnmasked()
```
    Get the EntityBioDemographicsContract's gender change code Corresponds to PESC GenderChangeCode
    
    Returns:
    
    the gender change code or null if no change
  - isSuppressPersonal
```
boolean isSuppressPersonal()
```
    Returns a boolean value that determines if personal fields should be suppressed.
    
    Returns:
    
    boolean value that determines if personal fields should be suppressed.

Interface EntityBioDemographicsContract

Field Summary

Method Summary

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

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

Field Detail

BIRTH_DATE_FORMAT

DECEASED_DATE_FORMAT

Method Detail

getEntityId

getDeceasedDate

getBirthDate

getGenderCode

getMaritalStatusCode

getPrimaryLanguageCode

getSecondaryLanguageCode

getBirthCountry

getBirthStateProvinceCode

getBirthCity

getGeographicOrigin

getBirthDateUnmasked

getAge

getGenderCodeUnmasked

getMaritalStatusCodeUnmasked

getPrimaryLanguageCodeUnmasked

getSecondaryLanguageCodeUnmasked

getBirthCountryUnmasked

getBirthStateProvinceCodeUnmasked

getBirthCityUnmasked

getGeographicOriginUnmasked

getNoteMessage

getGenderChangeCode

getGenderChangeCodeUnmasked

isSuppressPersonal