org.kuali.rice.kim.impl.identity.name

Class EntityNameBase

java.lang.Object

org.kuali.rice.krad.bo.DataObjectBase

org.kuali.rice.kim.impl.identity.name.EntityNameBase

All Implemented Interfaces:

Serializable, Inactivatable, Defaultable, GloballyUnique, Identifiable, Versioned, EntityNameContract

Direct Known Subclasses:

EntityNameBo

@MappedSuperclass
public abstract class EntityNameBase
extends DataObjectBase
implements EntityNameContract

See Also:

Serialized Form

Field Summary

Fields inherited from class org.kuali.rice.krad.bo.DataObjectBase

objectId, versionNumber

Fields inherited from interface org.kuali.rice.kim.api.identity.name.EntityNameContract

NAME_CHANGED_DATE_FORMAT

Constructor Summary

Constructors

Constructor and Description
EntityNameBase()

Method Summary

Modifier and Type	Method and Description
boolean	getActive()
String	getCompositeName() Return the entire name as the person or system wants it displayed.
String	getCompositeNameUnmasked() Gets this EntityNameContract's unmasked formatted name.
boolean	getDefaultValue()
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	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.
org.joda.time.DateTime	getNameChangedDate() Get the name change date EntityNameContract Corresponds to PESC name changed date
Timestamp	getNameChangedTimestamp()
String	getNameCode()
String	getNamePrefix() Gets this EntityNameContract's name prefix.
String	getNamePrefixUnmasked() Gets this EntityNameContract's unmasked name prefix.
String	getNameSuffix() Gets this EntityNameContract's suffix.
String	getNameSuffixUnmasked() Gets this EntityNameContract's unmasked suffix.
String	getNameTitle() Gets this EntityNameContract's name title.
String	getNameTitleUnmasked() Gets this EntityNameContract's unmasked name title.
String	getNoteMessage() Get the note associated with this EntityNameContract Corresponds to PESC NoteMessage
boolean	getSuppressName()
boolean	isActive() The active indicator for an object.
boolean	isDefaultValue() The default value for this object.
boolean	isSuppressName() Returns a boolean value that determines if email fields should be suppressed.
void	setActive(boolean active)
void	setDefaultValue(boolean defaultValue)
void	setEntityId(String entityId)
void	setFirstName(String firstName)
void	setLastName(String lastName)
void	setMiddleName(String middleName)
void	setNameChangedDate(org.joda.time.DateTime nameChangedDate)
void	setNameChangedTimestamp(Timestamp nameChangedDate)
void	setNameCode(String nameCode)
void	setNamePrefix(String namePrefix)
void	setNameSuffix(String nameSuffix)
void	setNameTitle(String nameTitle)
void	setNoteMessage(String noteMessage)
void	setSuppressName(boolean suppressName)

Methods inherited from class org.kuali.rice.krad.bo.DataObjectBase

generateAndSetObjectIdIfNeeded, getExtensionObject, getObjectId, getVersionNumber, prePersist, preUpdate, setExtensionObject, setObjectId, setVersionNumber, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.kuali.rice.kim.api.identity.name.EntityNameContract

getNameType

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

Constructor Detail

EntityNameBase

public EntityNameBase()

Method Detail

getFirstName

public String getFirstName()

Description copied from interface: EntityNameContract

Gets this EntityNameContract's first name.

Specified by:

getFirstName in interface EntityNameContract

Returns:

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

getMiddleName

public String getMiddleName()

Description copied from interface: EntityNameContract

Gets this EntityNameContract's middle name.

Specified by:

getMiddleName in interface EntityNameContract

Returns:

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

getLastName

public String getLastName()

Description copied from interface: EntityNameContract

Gets this EntityNameContract's last name.

Specified by:

getLastName in interface EntityNameContract

Returns:

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

getNamePrefix

public String getNamePrefix()

Description copied from interface: EntityNameContract

Gets this EntityNameContract's name prefix. Corresponds to PESC NamePrefix.

Specified by:

getNamePrefix in interface EntityNameContract

Returns:

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

getNameTitle

public String getNameTitle()

Description copied from interface: EntityNameContract

Gets this EntityNameContract's name title. Corresponds to PESC NameTitle.

Specified by:

getNameTitle in interface EntityNameContract

Returns:

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

getFirstNameUnmasked

public String getFirstNameUnmasked()

Description copied from interface: EntityNameContract

Gets this EntityNameContract's unmasked first name.

Specified by:

getFirstNameUnmasked in interface EntityNameContract

Returns:

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

getMiddleNameUnmasked

public String getMiddleNameUnmasked()

Description copied from interface: EntityNameContract

Gets this EntityNameContract's unmasked middle name.

Specified by:

getMiddleNameUnmasked in interface EntityNameContract

Returns:

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

getLastNameUnmasked

public String getLastNameUnmasked()

Description copied from interface: EntityNameContract

Gets this EntityNameContract's unmasked last name.

Specified by:

getLastNameUnmasked in interface EntityNameContract

Returns:

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

getNamePrefixUnmasked

public String getNamePrefixUnmasked()

Description copied from interface: EntityNameContract

Gets this EntityNameContract's unmasked name prefix. Corresponds to PESC NamePrefix.

Specified by:

getNamePrefixUnmasked in interface EntityNameContract

Returns:

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

getNameTitleUnmasked

public String getNameTitleUnmasked()

Description copied from interface: EntityNameContract

Gets this EntityNameContract's unmasked name title. Corresponds to PESC NameTitle.

Specified by:

getNameTitleUnmasked in interface EntityNameContract

Returns:

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

getNameSuffixUnmasked

public String getNameSuffixUnmasked()

Description copied from interface: EntityNameContract

Gets this EntityNameContract's unmasked suffix. Corresponds to PESC NameSuffix.

Specified by:

getNameSuffixUnmasked in interface EntityNameContract

Returns:

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

getCompositeName

public String getCompositeName()

Description copied from interface: EntityNameContract

Return the entire name as the person or system wants it displayed. Corresponds to PESC CompositeName.

Specified by:

getCompositeName in interface EntityNameContract

Returns:

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

getCompositeNameUnmasked

public String getCompositeNameUnmasked()

Description copied from interface: EntityNameContract

Gets this EntityNameContract's unmasked formatted name. Corresponds to PESC CompositeName.

Specified by:

getCompositeNameUnmasked in interface EntityNameContract

Returns:

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

getNameChangedDate

public org.joda.time.DateTime getNameChangedDate()

Description copied from interface: EntityNameContract

Get the name change date EntityNameContract Corresponds to PESC name changed date

Specified by:

getNameChangedDate in interface EntityNameContract

Returns:

the name change date of this EntityName

getNameChangedTimestamp

public Timestamp getNameChangedTimestamp()

isSuppressName

public boolean isSuppressName()

Description copied from interface: EntityNameContract

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

Specified by:

isSuppressName in interface EntityNameContract

Returns:

boolean value that determines if email should be suppressed.

getEntityId

public String getEntityId()

Description copied from interface: EntityNameContract

Gets this Entity's id.

Specified by:

getEntityId in interface EntityNameContract

Returns:

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

setEntityId

public void setEntityId(String entityId)

getNameCode

public String getNameCode()

setNameCode

public void setNameCode(String nameCode)

setFirstName

public void setFirstName(String firstName)

setMiddleName

public void setMiddleName(String middleName)

setLastName

public void setLastName(String lastName)

setNamePrefix

public void setNamePrefix(String namePrefix)

setNameTitle

public void setNameTitle(String nameTitle)

getNameSuffix

public String getNameSuffix()

Description copied from interface: EntityNameContract

Gets this EntityNameContract's suffix. Corresponds to PESC NameSuffix.

Specified by:

getNameSuffix in interface EntityNameContract

Returns:

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

setNameSuffix

public void setNameSuffix(String nameSuffix)

getActive

public boolean getActive()

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.

setActive

public void setActive(boolean active)

getDefaultValue

public boolean getDefaultValue()

isDefaultValue

public boolean isDefaultValue()

Description copied from interface: Defaultable

The default value for this object.

Specified by:

isDefaultValue in interface Defaultable

Returns:

the default value for this object

setDefaultValue

public void setDefaultValue(boolean defaultValue)

getNoteMessage

public String getNoteMessage()

Description copied from interface: EntityNameContract

Get the note associated with this EntityNameContract Corresponds to PESC NoteMessage

Specified by:

getNoteMessage in interface EntityNameContract

Returns:

the message associated with this EntityName

setNoteMessage

public void setNoteMessage(String noteMessage)

setNameChangedDate

public void setNameChangedDate(org.joda.time.DateTime nameChangedDate)

setNameChangedTimestamp

public void setNameChangedTimestamp(Timestamp nameChangedDate)

getSuppressName

public boolean getSuppressName()

setSuppressName

public void setSuppressName(boolean suppressName)