org.kuali.rice.kim.api.identity.email

Class EntityEmail

java.lang.Object

org.kuali.rice.core.api.mo.AbstractDataTransferObject

org.kuali.rice.kim.api.identity.email.EntityEmail

All Implemented Interfaces:

Serializable, Inactivatable, Defaultable, GloballyUnique, Identifiable, Versioned, ModelObjectBasic, ModelObjectComplete, EntityEmailContract

public class EntityEmail
extends AbstractDataTransferObject
implements EntityEmailContract

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EntityEmail.Builder A builder which can be used to construct EntityEmail instances.

Method Summary

Methods

Modifier and Type	Method and Description
String	getEmailAddress() Gets this EntityEmail's email address.
String	getEmailAddressUnmasked() Gets this EntityEmail's unmasked email address.
CodedAttribute	getEmailType() Gets this EntityEmail's type code.
String	getEntityId() Gets this id of the parent identity object.
String	getEntityTypeCode() Gets this entityTypeCode of the EntityEmailContract's object.
String	getId() The unique identifier for an object.
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	isDefaultValue() The default value for this object.
boolean	isSuppressEmail() 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

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

getEntityId

public String getEntityId()

Description copied from interface: EntityEmailContract

Gets this id of the parent identity object.

Specified by:

getEntityId in interface EntityEmailContract

Returns:

the identity id for this EntityEmailContract

getEntityTypeCode

public String getEntityTypeCode()

Description copied from interface: EntityEmailContract

Gets this entityTypeCode of the EntityEmailContract's object.

Specified by:

getEntityTypeCode in interface EntityEmailContract

Returns:

the identity type code for this EntityEmailContract

getEmailType

public CodedAttribute getEmailType()

Description copied from interface: EntityEmailContract

Gets this EntityEmail's type code.

Specified by:

getEmailType in interface EntityEmailContract

Returns:

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

getEmailAddress

public String getEmailAddress()

Description copied from interface: EntityEmailContract

Gets this EntityEmail's email address.

Specified by:

getEmailAddress in interface EntityEmailContract

Returns:

the email address for this EntityEmail, or null if none has been assigned.

getEmailAddressUnmasked

public String getEmailAddressUnmasked()

Description copied from interface: EntityEmailContract

Gets this EntityEmail's unmasked email address.

Specified by:

getEmailAddressUnmasked in interface EntityEmailContract

Returns:

the unmasked email address for this EntityEmail, or null if none has been assigned.

isSuppressEmail

public boolean isSuppressEmail()

Description copied from interface: EntityEmailContract

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

Specified by:

isSuppressEmail in interface EntityEmailContract

Returns:

boolean value that determines if email should be suppressed.

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

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

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.