org.kuali.rice.kim.api.identity.personal
Class EntityBioDemographics.Builder

java.lang.Object
  extended by org.kuali.rice.kim.api.identity.personal.EntityBioDemographics.Builder
All Implemented Interfaces:
Serializable, GloballyUnique, Versioned, ModelBuilder, EntityBioDemographicsContract
Enclosing class:
EntityBioDemographics

public static final class EntityBioDemographics.Builder
extends Object
implements Serializable, ModelBuilder, EntityBioDemographicsContract

A builder which can be used to construct EntityBioDemographics instances. Enforces the constraints of the EntityBioDemographicsContract.

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface org.kuali.rice.kim.api.identity.personal.EntityBioDemographicsContract
BIRTH_DATE_FORMAT, DECEASED_DATE_FORMAT
 
Method Summary
 EntityBioDemographics build()
          Returns an instance of the object being built by this builder based on the current state of the builder.
static EntityBioDemographics.Builder create(EntityBioDemographicsContract contract)
           
static EntityBioDemographics.Builder create(String entityId, String genderCode)
           
 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 getObjectId()
          Return the globally unique object id of this object.
 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.
 Long getVersionNumber()
          Returns the version number for this object.
 boolean isSuppressPersonal()
          Returns a boolean value that determines if personal fields should be suppressed.
 void setBirthCity(String birthCity)
           
 void setBirthCountry(String birthCountry)
           
 void setBirthDate(Date birthDate)
           
 void setBirthDate(String birthDate)
           
 void setBirthStateProvinceCode(String birthStateProvinceCode)
           
 void setDeceasedDate(Date deceasedDate)
           
 void setDeceasedDate(String deceasedDate)
           
 void setEntityId(String entityId)
           
 void setGenderChangeCode(String genderChangeCode)
           
 void setGenderCode(String genderCode)
           
 void setGeographicOrigin(String geographicOrigin)
           
 void setMaritalStatusCode(String maritalStatusCode)
           
 void setObjectId(String objectId)
           
 void setPrimaryLanguageCode(String primaryLanguageCode)
           
 void setSecondaryLanguageCode(String secondaryLanguageCode)
           
 void setVersionNumber(Long versionNumber)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

create

public static EntityBioDemographics.Builder create(String entityId,
                                                   String genderCode)

create

public static EntityBioDemographics.Builder create(EntityBioDemographicsContract contract)

build

public EntityBioDemographics build()
Description copied from interface: ModelBuilder
Returns an instance of the object being built by this builder based on the current state of the builder. It should be possible to invoke this method more than once on the same builder. It should never return null;

Specified by:
build in interface ModelBuilder
Returns:
an instance of the object being built by this builder, should never return null

getEntityId

public String getEntityId()
Description copied from interface: EntityBioDemographicsContract
Gets this EntityBioDemographicsContract's identity id.

Specified by:
getEntityId in interface EntityBioDemographicsContract
Returns:
the identity id for this EntityBioDemographicsContract, or null if none has been assigned.

getDeceasedDate

public String getDeceasedDate()
Description copied from interface: EntityBioDemographicsContract
Gets this EntityBioDemographicsContract's deceased date.

Specified by:
getDeceasedDate in interface EntityBioDemographicsContract
Returns:
the deceased date for this EntityBioDemographicsContract, or null if none has been assigned.

getBirthDate

public String getBirthDate()
Description copied from interface: EntityBioDemographicsContract
Gets this EntityBioDemographicsContract's birth date.

Specified by:
getBirthDate in interface EntityBioDemographicsContract
Returns:
the birth date for this EntityBioDemographicsContract, or null if none has been assigned.

getAge

public Integer getAge()
Description copied from interface: EntityBioDemographicsContract
Gets this EntityBioDemographicsContract's current age based on birth date if present. Age calculation uses deceased date if present.

Specified by:
getAge in interface EntityBioDemographicsContract
Returns:
the calculated age for this EntityBioDemographicsContract, or null if EntityBioDemographicsContract.getBirthDate() is unpresent, suppressed, or there is a calculation error.

getGenderCode

public String getGenderCode()
Description copied from interface: EntityBioDemographicsContract
Gets this EntityBioDemographicsContract's gender code.

Specified by:
getGenderCode in interface EntityBioDemographicsContract
Returns:
the gender code for this EntityBioDemographicsContract, or null if none has been assigned.

getGenderChangeCode

public String getGenderChangeCode()
Description copied from interface: EntityBioDemographicsContract
Get the EntityBioDemographicsContract's gender change code Corresponds to PESC GenderChangeCode

Specified by:
getGenderChangeCode in interface EntityBioDemographicsContract
Returns:
the gender change code or null if no change

getMaritalStatusCode

public String getMaritalStatusCode()
Description copied from interface: EntityBioDemographicsContract
Gets this EntityBioDemographicsContract's marital status code.

Specified by:
getMaritalStatusCode in interface EntityBioDemographicsContract
Returns:
the marital status code for this EntityBioDemographicsContract, or null if none has been assigned.

getPrimaryLanguageCode

public String getPrimaryLanguageCode()
Description copied from interface: EntityBioDemographicsContract
Gets this EntityBioDemographicsContract's primary language code.

Specified by:
getPrimaryLanguageCode in interface EntityBioDemographicsContract
Returns:
the primary language code for this EntityBioDemographicsContract, or null if none has been assigned.

getSecondaryLanguageCode

public String getSecondaryLanguageCode()
Description copied from interface: EntityBioDemographicsContract
Gets this EntityBioDemographicsContract's secondary language code.

Specified by:
getSecondaryLanguageCode in interface EntityBioDemographicsContract
Returns:
the secondary language code for this EntityBioDemographicsContract, or null if none has been assigned.

getBirthCountry

public String getBirthCountry()
Description copied from interface: EntityBioDemographicsContract
Gets this EntityBioDemographicsContract's country of birth code. Corresponds to PESC BirthCountry.

Specified by:
getBirthCountry in interface EntityBioDemographicsContract
Returns:
the country of birth code for this EntityBioDemographicsContract, or null if none has been assigned.

getBirthStateProvinceCode

public String getBirthStateProvinceCode()
Description copied from interface: EntityBioDemographicsContract
Gets this EntityBioDemographicsContract's birth state or extra-state jurisdiction code. Corresponds to PESC BirthStateProvinceCode.

Specified by:
getBirthStateProvinceCode in interface EntityBioDemographicsContract
Returns:
the birth state code for this EntityBioDemographicsContract, or null if none has been assigned.

getBirthCity

public String getBirthCity()
Description copied from interface: EntityBioDemographicsContract
Gets this EntityBioDemographicsContract's city of birth. Corresponds to PESC BirthCity.

Specified by:
getBirthCity in interface EntityBioDemographicsContract
Returns:
the city of birth for this EntityBioDemographicsContract, or null if none has been assigned.

getGeographicOrigin

public String getGeographicOrigin()
Description copied from interface: EntityBioDemographicsContract
Gets this EntityBioDemographicsContract's geographic origin.

Specified by:
getGeographicOrigin in interface EntityBioDemographicsContract
Returns:
the geographic origin for this EntityBioDemographicsContract, or null if none has been assigned.

getBirthDateUnmasked

public String getBirthDateUnmasked()
Description copied from interface: EntityBioDemographicsContract
Gets this EntityBioDemographicsContract's unmasked birth date.

Specified by:
getBirthDateUnmasked in interface EntityBioDemographicsContract
Returns:
the unmasked birth date for this EntityBioDemographicsContract, or null if none has been assigned.

getGenderCodeUnmasked

public String getGenderCodeUnmasked()
Description copied from interface: EntityBioDemographicsContract
Gets this EntityBioDemographicsContract's unmasked gender code.

Specified by:
getGenderCodeUnmasked in interface EntityBioDemographicsContract
Returns:
the unmasked gender code for this EntityBioDemographicsContract, or null if none has been assigned.

getGenderChangeCodeUnmasked

public String getGenderChangeCodeUnmasked()
Description copied from interface: EntityBioDemographicsContract
Get the EntityBioDemographicsContract's gender change code Corresponds to PESC GenderChangeCode

Specified by:
getGenderChangeCodeUnmasked in interface EntityBioDemographicsContract
Returns:
the gender change code or null if no change

getMaritalStatusCodeUnmasked

public String getMaritalStatusCodeUnmasked()
Description copied from interface: EntityBioDemographicsContract
Gets this EntityBioDemographicsContract's unmasked martial status code.

Specified by:
getMaritalStatusCodeUnmasked in interface EntityBioDemographicsContract
Returns:
the unmasked martial status code for this EntityBioDemographicsContract, or null if none has been assigned.

getPrimaryLanguageCodeUnmasked

public String getPrimaryLanguageCodeUnmasked()
Description copied from interface: EntityBioDemographicsContract
Gets this EntityBioDemographicsContract's unmasked primary language code.

Specified by:
getPrimaryLanguageCodeUnmasked in interface EntityBioDemographicsContract
Returns:
the unmasked primary language code for this EntityBioDemographicsContract, or null if none has been assigned.

getSecondaryLanguageCodeUnmasked

public String getSecondaryLanguageCodeUnmasked()
Description copied from interface: EntityBioDemographicsContract
Gets this EntityBioDemographicsContract's unmasked secondary language code.

Specified by:
getSecondaryLanguageCodeUnmasked in interface EntityBioDemographicsContract
Returns:
the unmasked secondary language code for this EntityBioDemographicsContract, or null if none has been assigned.

getBirthCountryUnmasked

public String getBirthCountryUnmasked()
Description copied from interface: EntityBioDemographicsContract
Gets this EntityBioDemographicsContract's unmasked country of birth code.

Specified by:
getBirthCountryUnmasked in interface EntityBioDemographicsContract
Returns:
the unmasked country of birth code for this EntityBioDemographicsContract, or null if none has been assigned.

getBirthStateProvinceCodeUnmasked

public String getBirthStateProvinceCodeUnmasked()
Description copied from interface: EntityBioDemographicsContract
Gets this EntityBioDemographicsContract's unmasked birth state or extra-state jurisdiction code. Corresponds to PESC BirthStateProvinceCode.

Specified by:
getBirthStateProvinceCodeUnmasked in interface EntityBioDemographicsContract
Returns:
the unmaksed birth state code for this EntityBioDemographicsContract, or null if none has been assigned.

getBirthCityUnmasked

public String getBirthCityUnmasked()
Description copied from interface: EntityBioDemographicsContract
Gets this EntityBioDemographicsContract's unmasked city of birth. Corresponds to PESC BirthCity.

Specified by:
getBirthCityUnmasked in interface EntityBioDemographicsContract
Returns:
the unmasked city of birth for this EntityBioDemographicsContract, or null if none has been assigned.

getGeographicOriginUnmasked

public String getGeographicOriginUnmasked()
Description copied from interface: EntityBioDemographicsContract
Gets this EntityBioDemographicsContract's unmasked geographic origin.

Specified by:
getGeographicOriginUnmasked in interface EntityBioDemographicsContract
Returns:
the unmasked geographic origin for this EntityBioDemographicsContract, or null if none has been assigned.

getNoteMessage

public String getNoteMessage()
Description copied from interface: EntityBioDemographicsContract
Get the note associated with this EntityBioDemographicsContract Corresponds to PESC NoteMessage

Specified by:
getNoteMessage in interface EntityBioDemographicsContract
Returns:
the message associated with this EntityName

isSuppressPersonal

public boolean isSuppressPersonal()
Description copied from interface: EntityBioDemographicsContract
Returns a boolean value that determines if personal fields should be suppressed.

Specified by:
isSuppressPersonal in interface EntityBioDemographicsContract
Returns:
boolean value that determines if personal fields should be suppressed.

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

setEntityId

public void setEntityId(String entityId)

setDeceasedDate

public void setDeceasedDate(String deceasedDate)

setBirthDate

public void setBirthDate(String birthDate)

setDeceasedDate

public void setDeceasedDate(Date deceasedDate)

setBirthDate

public void setBirthDate(Date birthDate)

setGenderCode

public void setGenderCode(String genderCode)

setGenderChangeCode

public void setGenderChangeCode(String genderChangeCode)

setMaritalStatusCode

public void setMaritalStatusCode(String maritalStatusCode)

setPrimaryLanguageCode

public void setPrimaryLanguageCode(String primaryLanguageCode)

setSecondaryLanguageCode

public void setSecondaryLanguageCode(String secondaryLanguageCode)

setBirthCountry

public void setBirthCountry(String birthCountry)

setBirthStateProvinceCode

public void setBirthStateProvinceCode(String birthStateProvinceCode)

setBirthCity

public void setBirthCity(String birthCity)

setGeographicOrigin

public void setGeographicOrigin(String geographicOrigin)

setVersionNumber

public void setVersionNumber(Long versionNumber)

setObjectId

public void setObjectId(String objectId)


Copyright © 2005-2011 The Kuali Foundation. All Rights Reserved.