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

java.lang.Object
  org.kuali.rice.kim.api.identity.personal.EntityEthnicityHistory.Builder

All Implemented Interfaces:

Serializable, Inactivatable, InactivatableFromTo, GloballyUnique, Historical, Identifiable, Versioned, ModelBuilder, EntityEthnicityContract, EntityEthnicityHistoryContract

Enclosing class:

EntityEthnicityHistory

public static final class EntityEthnicityHistory.Builder
extends Object
implements Serializable, ModelBuilder, EntityEthnicityHistoryContract

A builder which can be used to construct EntityEthnicityHistory instances. Enforces the constraints of the EntityEthnicityContract.

See Also:

Serialized Form

Method Summary

EntityEthnicityHistory	build() Returns an instance of the object being built by this builder based on the current state of the builder.
static EntityEthnicityHistory.Builder	create()
static EntityEthnicityHistory.Builder	create(EntityEthnicityHistoryContract contract)
org.joda.time.DateTime	getActiveFromDate() Gets the date for which the record become active.
org.joda.time.DateTime	getActiveToDate() Gets the date for which the record become inactive.
String	getEntityId() Gets this EntityEthnicityContract's identity id.
String	getEthnicityCode()
String	getEthnicityCodeUnmasked()
Long	getHistoryId()
String	getId() The unique identifier for an object.
String	getLocalRaceEthnicityCode() Categories used in local exchanges (such as within states or provinces) to describe groups to which individuals belong or identify with by race or ethnicity.
String	getLocalRaceEthnicityCodeUnmasked() Unmasked categories used in local exchanges (such as within states or provinces) to describe groups to which individuals belong or identify with by race or ethnicity.
String	getObjectId() Return the globally unique object id of this object.
Double	getPercentage() Gets a EntityEthnicityContract's ethnicity code's percentage.
Double	getPercentageUnmasked() Gets a EntityEthnicityContract's ethnicity code's unmasked percentage.
CodedAttributeHistory.Builder	getRaceEthnicityCode() Gets a list of this EntityEthnicityContract's ethnicity codes.
CodedAttributeHistory.Builder	getRaceEthnicityCodeUnmasked() Gets a list of unmasked EntityEthnicityContract's ethnicity codes.
String	getSubEthnicityCode()
String	getSubEthnicityCodeUnmasked()
Long	getVersionNumber() Returns the version number for this object.
boolean	isActive() The active indicator for an object.
boolean	isActive(org.joda.time.DateTime activeAsOf) Returns if the record is active for a given Time.
boolean	isActiveNow()
boolean	isHispanicOrLatino() Gets this EntityEthnicityContract's is hispanic or latino.
boolean	isSuppressPersonal() Returns a boolean value that determines if personal fields should be suppressed.
void	setActiveFromDate(org.joda.time.DateTime activeFromDate)
void	setActiveToDate(org.joda.time.DateTime activeToDate)
void	setEntityId(String entityId)
void	setEthnicityCode(String ethnicityCode)
void	setHispanicOrLatino(boolean hispanicOrLatino)
void	setHistoryId(Long historyId)
void	setId(String id)
void	setLocalRaceEthnicityCode(String localRaceEthnicityCode)
void	setObjectId(String objectId)
void	setPercentage(Double percentage)
void	setRaceEthnicityCodes(CodedAttributeHistory.Builder raceEthnicityCode)
void	setSubEthnicityCode(String subEthnicityCode)
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 EntityEthnicityHistory.Builder create()

create

public static EntityEthnicityHistory.Builder create(EntityEthnicityHistoryContract contract)

build

public EntityEthnicityHistory 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: EntityEthnicityContract

Gets this EntityEthnicityContract's identity id.

Specified by:

getEntityId in interface EntityEthnicityContract

Returns:

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

getEthnicityCode

public String getEthnicityCode()

Specified by:

getEthnicityCode in interface EntityEthnicityContract

Returns:

the ethnicity code for this EntityEthnicityContract, or null if none has been assigned.

getEthnicityCodeUnmasked

public String getEthnicityCodeUnmasked()

Specified by:

getEthnicityCodeUnmasked in interface EntityEthnicityContract

Returns:

the unmasked ethnicity code for this EntityEthnicityContract, or null if none has been assigned.

getSubEthnicityCode

public String getSubEthnicityCode()

Specified by:

getSubEthnicityCode in interface EntityEthnicityContract

Returns:

the sub-ethnicity code for this EntityEthnicityContract, or null if none has been assigned.

getSubEthnicityCodeUnmasked

public String getSubEthnicityCodeUnmasked()

Specified by:

getSubEthnicityCodeUnmasked in interface EntityEthnicityContract

Returns:

the unmasked sub-ethnicity code for this EntityEthnicityContract, or null if none has been assigned.

isSuppressPersonal

public boolean isSuppressPersonal()

Description copied from interface: EntityEthnicityContract

Returns a boolean value that determines if personal fields should be suppressed.

Specified by:

isSuppressPersonal in interface EntityEthnicityContract

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

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

isHispanicOrLatino

public boolean isHispanicOrLatino()

Description copied from interface: EntityEthnicityContract

Gets this EntityEthnicityContract's is hispanic or latino.

Specified by:

isHispanicOrLatino in interface EntityEthnicityContract

Returns:

whether the EntityEthnicityContract, is hispanic or latino.

getRaceEthnicityCode

public CodedAttributeHistory.Builder getRaceEthnicityCode()

Description copied from interface: EntityEthnicityHistoryContract

Gets a list of this EntityEthnicityContract's ethnicity codes.

Specified by:

getRaceEthnicityCode in interface EntityEthnicityContract

Specified by:

getRaceEthnicityCode in interface EntityEthnicityHistoryContract

Returns:

the ethnicity codes for this EntityEthnicityContract, or an empty list if none has been assigned.

getRaceEthnicityCodeUnmasked

public CodedAttributeHistory.Builder getRaceEthnicityCodeUnmasked()

Description copied from interface: EntityEthnicityHistoryContract

Gets a list of unmasked EntityEthnicityContract's ethnicity codes.

Specified by:

getRaceEthnicityCodeUnmasked in interface EntityEthnicityContract

Specified by:

getRaceEthnicityCodeUnmasked in interface EntityEthnicityHistoryContract

Returns:

the unmasked ethnicity codes for this EntityEthnicityContract, or an empty list if none has been assigned.

getLocalRaceEthnicityCode

public String getLocalRaceEthnicityCode()

Description copied from interface: EntityEthnicityContract

Categories used in local exchanges (such as within states or provinces) to describe groups to which individuals belong or identify with by race or ethnicity. This element may be used to add more information or granularity to nationally defined codes. This element may also be used in place of a national code set where required by local practice.

Specified by:

getLocalRaceEthnicityCode in interface EntityEthnicityContract

Returns:

the local ethnicity code used in local exchanges for this EntityEthnicityContract, or null if none has been assigned

getLocalRaceEthnicityCodeUnmasked

public String getLocalRaceEthnicityCodeUnmasked()

Description copied from interface: EntityEthnicityContract

Unmasked categories used in local exchanges (such as within states or provinces) to describe groups to which individuals belong or identify with by race or ethnicity. This element may be used to add more information or granularity to nationally defined codes. This element may also be used in place of a national code set where required by local practice.

Specified by:

getLocalRaceEthnicityCodeUnmasked in interface EntityEthnicityContract

Returns:

the local ethnicity code used in local exchanges for this EntityEthnicityContract, or null if none has been assigned

getHistoryId

public Long getHistoryId()

Specified by:

getHistoryId in interface Historical

isActiveNow

public boolean isActiveNow()

Specified by:

isActiveNow in interface Historical

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.

isActive

public boolean isActive(org.joda.time.DateTime activeAsOf)

Description copied from interface: InactivatableFromTo

Returns if the record is active for a given Time. If the activeAsOfDate is null will return null.

Specified by:

isActive in interface InactivatableFromTo

Returns:

true if active false if not

getActiveFromDate

public org.joda.time.DateTime getActiveFromDate()

Description copied from interface: InactivatableFromTo

Gets the date for which the record become active. Can be null.

Specified by:

getActiveFromDate in interface InactivatableFromTo

Returns:

Timestamp of active from date

getActiveToDate

public org.joda.time.DateTime getActiveToDate()

Description copied from interface: InactivatableFromTo

Gets the date for which the record become inactive. Can be null.

Specified by:

getActiveToDate in interface InactivatableFromTo

Returns:

Timestamp of active to date

getPercentage

public Double getPercentage()

Description copied from interface: EntityEthnicityContract

Gets a EntityEthnicityContract's ethnicity code's percentage.

Specified by:

getPercentage in interface EntityEthnicityContract

Returns:

the percent for this EntityEthnicityContract record.

getPercentageUnmasked

public Double getPercentageUnmasked()

Description copied from interface: EntityEthnicityContract

Gets a EntityEthnicityContract's ethnicity code's unmasked percentage.

Specified by:

getPercentageUnmasked in interface EntityEthnicityContract

Returns:

the percent for this EntityEthnicityContract record.

setHistoryId

public void setHistoryId(Long historyId)

setActiveFromDate

public void setActiveFromDate(org.joda.time.DateTime activeFromDate)

setActiveToDate

public void setActiveToDate(org.joda.time.DateTime activeToDate)

setHispanicOrLatino

public void setHispanicOrLatino(boolean hispanicOrLatino)

setRaceEthnicityCodes

public void setRaceEthnicityCodes(CodedAttributeHistory.Builder raceEthnicityCode)

setLocalRaceEthnicityCode

public void setLocalRaceEthnicityCode(String localRaceEthnicityCode)

setEntityId

public void setEntityId(String entityId)

setEthnicityCode

public void setEthnicityCode(String ethnicityCode)

setSubEthnicityCode

public void setSubEthnicityCode(String subEthnicityCode)

setVersionNumber

public void setVersionNumber(Long versionNumber)

setObjectId

public void setObjectId(String objectId)

setId

public void setId(String id)

setPercentage

public void setPercentage(Double percentage)