EntityBioDemographics.Builder (Rice 2.0.1 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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

java.lang.Object
  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
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