org.kuali.rice.kim.api.identity.personal

Class EntityEthnicity.Builder

java.lang.Object

org.kuali.rice.kim.api.identity.personal.EntityEthnicity.Builder

All Implemented Interfaces:

Serializable, GloballyUnique, Identifiable, Versioned, ModelBuilder, EntityEthnicityContract

Enclosing class:

EntityEthnicity

public static final class EntityEthnicity.Builder
extends Object
implements Serializable, ModelBuilder, EntityEthnicityContract

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

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
EntityEthnicity	build() Returns an instance of the object being built by this builder based on the current state of the builder.
static EntityEthnicity.Builder	create()
static EntityEthnicity.Builder	create(EntityEthnicityContract contract)
String	getEntityId() Gets this EntityEthnicityContract's identity id.
String	getEthnicityCode() Gets this EntityEthnicityContract's ethnicity code.
String	getEthnicityCodeUnmasked() Gets this EntityEthnicityContract's unmasked ethnicity code.
String	getId() The unique identifier for an object.
String	getObjectId() Return the globally unique object id of this object.
String	getSubEthnicityCode() Gets this EntityEthnicityContract's sub-ethnicity code.
String	getSubEthnicityCodeUnmasked() Gets this EntityEthnicityContract's unmasked sub-ethnicity 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	setEntityId(String entityId)
void	setEthnicityCode(String ethnicityCode)
void	setId(String id)
void	setObjectId(String objectId)
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 EntityEthnicity.Builder create()

create

public static EntityEthnicity.Builder create(EntityEthnicityContract contract)

build

public EntityEthnicity 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()

Description copied from interface: EntityEthnicityContract

Gets this EntityEthnicityContract's ethnicity code.

Specified by:

getEthnicityCode in interface EntityEthnicityContract

Returns:

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

getEthnicityCodeUnmasked

public String getEthnicityCodeUnmasked()

Description copied from interface: EntityEthnicityContract

Gets this EntityEthnicityContract's unmasked ethnicity code.

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()

Description copied from interface: EntityEthnicityContract

Gets this EntityEthnicityContract's sub-ethnicity code.

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()

Description copied from interface: EntityEthnicityContract

Gets this EntityEthnicityContract's unmasked sub-ethnicity code.

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

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)