org.kuali.rice.kim.api.identity.name
Interface EntityNameContract

All Superinterfaces:

Defaultable, GloballyUnique, Identifiable, Inactivatable, Versioned

All Known Implementing Classes:

EntityName, EntityName.Builder, EntityNameBo

public interface EntityNameContract
extends Versioned, GloballyUnique, Defaultable, Inactivatable, Identifiable

Method Summary

String	getEntityId() Gets this Entity's id.
String	getFirstName() Gets this EntityNameContract's first name.
String	getFirstNameUnmasked() Gets this EntityNameContract's unmasked first name.
String	getFormattedName() Return the entire name as the person or system wants it displayed.
String	getFormattedNameUnmasked() Gets this EntityNameContract's unmasked formatted name.
String	getLastName() Gets this EntityNameContract's last name.
String	getLastNameUnmasked() Gets this EntityNameContract's unmasked last name.
String	getMiddleName() Gets this EntityNameContract's middle name.
String	getMiddleNameUnmasked() Gets this EntityNameContract's unmasked middle name.
TypeContract	getNameType() Gets this EntityNameContract's TypeContract.
String	getSuffix() Gets this EntityNameContract's suffix.
String	getSuffixUnmasked() Gets this EntityNameContract's unmasked suffix.
String	getTitle() Gets this EntityNameContract's title.
String	getTitleUnmasked() Gets this EntityNameContract's unmasked title.
boolean	isSuppressName() Returns a boolean value that determines if email 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.Defaultable

isDefaultValue

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

isActive

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

getId

Method Detail

getEntityId

String getEntityId()

Gets this Entity's id.

Returns:

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

getNameType

TypeContract getNameType()

Gets this EntityNameContract's TypeContract.

Returns:

the type for this EntityNameContract, or null if none has been assigned.

getFirstName

String getFirstName()

Gets this EntityNameContract's first name.

Returns:

the first name for this EntityNameContract, or null if none has been assigned.

getFirstNameUnmasked

String getFirstNameUnmasked()

Gets this EntityNameContract's unmasked first name.

Returns:

the unmasked first name for this EntityNameContract, or null if none has been assigned.

getMiddleName

String getMiddleName()

Gets this EntityNameContract's middle name.

Returns:

the middle name for this EntityNameContract, or null if none has been assigned.

getMiddleNameUnmasked

String getMiddleNameUnmasked()

Gets this EntityNameContract's unmasked middle name.

Returns:

the unmasked middle name for this EntityNameContract, or null if none has been assigned.

getLastName

String getLastName()

Gets this EntityNameContract's last name.

Returns:

the last name for this EntityNameContract, or null if none has been assigned.

getLastNameUnmasked

String getLastNameUnmasked()

Gets this EntityNameContract's unmasked last name.

Returns:

the unmasked last name for this EntityNameContract, or null if none has been assigned.

getTitle

String getTitle()

Gets this EntityNameContract's title.

Returns:

the title for this EntityNameContract, or null if none has been assigned.

getTitleUnmasked

String getTitleUnmasked()

Gets this EntityNameContract's unmasked title.

Returns:

the unmasked title for this EntityNameContract, or null if none has been assigned.

getSuffix

String getSuffix()

Gets this EntityNameContract's suffix.

Returns:

the suffix for this EntityNameContract, or null if none has been assigned.

getSuffixUnmasked

String getSuffixUnmasked()

Gets this EntityNameContract's unmasked suffix.

Returns:

the unmasked suffix for this EntityNameContract, or null if none has been assigned.

getFormattedName

String getFormattedName()

Return the entire name as the person or system wants it displayed.

Returns:

the complete name in the format of "lastName, firstName middleName"

getFormattedNameUnmasked

String getFormattedNameUnmasked()

Gets this EntityNameContract's unmasked formatted name.

Returns:

the complete name in the format of "lastName, firstName middleName"

isSuppressName

boolean isSuppressName()

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

Returns:

boolean value that determines if email should be suppressed.