Package 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	Description
static final class	EntityEmail.Builder	A builder which can be used to construct EntityEmail instances.

Method Summary

Modifier and Type	Method	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()
String	getObjectId()
Long	getVersionNumber()
boolean	isActive()
boolean	isDefaultValue()
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 Details

getId

public String getId()

Specified by:

getId in interface Identifiable

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()

Specified by:

isDefaultValue in interface Defaultable

getVersionNumber

public Long getVersionNumber()

Specified by:

getVersionNumber in interface Versioned

getObjectId

public String getObjectId()

Specified by:

getObjectId in interface GloballyUnique

isActive

public boolean isActive()

Specified by:

isActive in interface Inactivatable