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

All Superinterfaces:

GloballyUnique, Identifiable, Versioned

All Known Subinterfaces:

EntityEthnicityHistoryContract

All Known Implementing Classes:

EntityEthnicity, EntityEthnicity.Builder, EntityEthnicityBo, EntityEthnicityHistory, EntityEthnicityHistory.Builder

public interface EntityEthnicityContract
extends Versioned, GloballyUnique, Identifiable

ethnicity information for a KIM identity

Author:

Kuali Rice Team (kuali-rice@googlegroups.com)

Method Summary

String	getEntityId() Gets this EntityEthnicityContract's identity id.
String	getEthnicityCode() Deprecated. Deprecated in Rice 2.3.0. Use getRaceEthnicityCodes() Gets this EntityEthnicityContract's ethnicity code.
String	getEthnicityCodeUnmasked() Deprecated. Deprecated in Rice 2.3.0. Use getRaceEthnicityCodesUnmasked() Gets this EntityEthnicityContract's unmasked ethnicity code.
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.
Double	getPercentage() Gets a EntityEthnicityContract's ethnicity code's percentage.
Double	getPercentageUnmasked() Gets a EntityEthnicityContract's ethnicity code's unmasked percentage.
CodedAttributeContract	getRaceEthnicityCode() Gets a EntityEthnicityContract's ethnicity code.
CodedAttributeContract	getRaceEthnicityCodeUnmasked() Gets a EntityEthnicityContract's ethnicity code unmasked.
String	getSubEthnicityCode() Deprecated. Deprecated in Rice 2.3.0. Use getLocalRaceEthnicityCodes() Gets this EntityEthnicityContract's sub-ethnicity code.
String	getSubEthnicityCodeUnmasked() Deprecated. Deprecated in Rice 2.3.0. Use getLocalRaceEthnicityCodesUnmasked() Gets this EntityEthnicityContract's unmasked sub-ethnicity code.
boolean	isHispanicOrLatino() Gets this EntityEthnicityContract's is hispanic or latino.
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

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

getId

Method Detail

getEntityId

String getEntityId()

Gets this EntityEthnicityContract's identity id.

Returns:

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

getEthnicityCode

@Deprecated
String getEthnicityCode()

Deprecated. Deprecated in Rice 2.3.0. Use getRaceEthnicityCodes() Gets this EntityEthnicityContract's ethnicity code.

Returns:

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

getEthnicityCodeUnmasked

@Deprecated
String getEthnicityCodeUnmasked()

Deprecated. Deprecated in Rice 2.3.0. Use getRaceEthnicityCodesUnmasked() Gets this EntityEthnicityContract's unmasked ethnicity code.

Returns:

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

getSubEthnicityCode

@Deprecated
String getSubEthnicityCode()

Deprecated. Deprecated in Rice 2.3.0. Use getLocalRaceEthnicityCodes() Gets this EntityEthnicityContract's sub-ethnicity code.

Returns:

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

getSubEthnicityCodeUnmasked

@Deprecated
String getSubEthnicityCodeUnmasked()

Deprecated. Deprecated in Rice 2.3.0. Use getLocalRaceEthnicityCodesUnmasked() Gets this EntityEthnicityContract's unmasked sub-ethnicity code.

Returns:

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

isHispanicOrLatino

boolean isHispanicOrLatino()

Gets this EntityEthnicityContract's is hispanic or latino.

Returns:

whether the EntityEthnicityContract, is hispanic or latino.

getRaceEthnicityCode

CodedAttributeContract getRaceEthnicityCode()

Gets a EntityEthnicityContract's ethnicity code.

Returns:

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

getPercentage

Double getPercentage()

Gets a EntityEthnicityContract's ethnicity code's percentage.

Returns:

the percent for this EntityEthnicityContract record.

getPercentageUnmasked

Double getPercentageUnmasked()

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

Returns:

the percent for this EntityEthnicityContract record.

getRaceEthnicityCodeUnmasked

CodedAttributeContract getRaceEthnicityCodeUnmasked()

Gets a EntityEthnicityContract's ethnicity code unmasked.

Returns:

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

getLocalRaceEthnicityCode

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. 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.

Returns:

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

getLocalRaceEthnicityCodeUnmasked

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. 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.

Returns:

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

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.