org.kuali.rice.kim.api.identity.name
Class EntityNameHistory

java.lang.Object
  org.kuali.rice.core.api.mo.AbstractDataTransferObject
      org.kuali.rice.kim.api.identity.name.EntityNameHistory

All Implemented Interfaces:

Serializable, Inactivatable, InactivatableFromTo, Defaultable, GloballyUnique, Historical, Identifiable, Versioned, ModelObjectBasic, ModelObjectComplete, EntityNameContract, EntityNameHistoryContract

public final class EntityNameHistory
extends AbstractDataTransferObject
implements EntityNameHistoryContract

See Also:

Serialized Form

Nested Class Summary

static class

EntityNameHistory.Builder A builder which can be used to construct EntityNameHistory instances.

Field Summary

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

NAME_CHANGED_DATE_FORMAT

Method Summary

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	getCompositeName() Return the entire name as the person or system wants it displayed.
String	getCompositeNameUnmasked() Gets this EntityNameContract's unmasked formatted name.
String	getEntityId() Gets this Entity's id.
String	getFirstName() Gets this EntityNameContract's first name.
String	getFirstNameUnmasked() Gets this EntityNameContract's unmasked first name.
Long	getHistoryId()
String	getId() The unique identifier for an object.
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
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.
CodedAttributeHistory	getNameType() Gets this EntityNameHistoryContract's TypeContract.
String	getNoteMessage() Get the note associated with this EntityNameContract Corresponds to PESC NoteMessage
String	getObjectId() Return the globally unique object id of this object.
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	isDefaultValue() The default value for this object.
boolean	isSuppressName() Returns a boolean value that determines if email fields should be suppressed.

Methods inherited from class org.kuali.rice.core.api.mo.AbstractDataTransferObject

afterUnmarshal, beforeUnmarshal, equals, equalsExcludeFields, getDefaultHashCodeEqualsExcludeFields, hashCode, hashCodeExcludeFields, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

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.

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.

getNameType

public CodedAttributeHistory getNameType()

Description copied from interface: EntityNameHistoryContract

Gets this EntityNameHistoryContract's TypeContract.

Specified by:

getNameType in interface EntityNameContract

Specified by:

getNameType in interface EntityNameHistoryContract

Returns:

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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"

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

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

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.

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

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

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.

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

getHistoryId

public Long getHistoryId()

Specified by:

getHistoryId in interface Historical

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

isActiveNow

public boolean isActiveNow()

Specified by:

isActiveNow in interface Historical

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