EntityEmail.Builder (Rice 2.5.19 API)

java.lang.Object
- org.kuali.rice.kim.api.identity.email.EntityEmail.Builder

All Implemented Interfaces:

Serializable, Inactivatable, Defaultable, GloballyUnique, Identifiable, Versioned, ModelBuilder, EntityEmailContract

Enclosing class:

EntityEmail
```
public static final class EntityEmail.Builder
extends Object
implements Serializable, ModelBuilder, EntityEmailContract
```
A builder which can be used to construct EntityEmail instances. Enforces the constraints of the EntityEmailContract.

See Also:

Serialized Form

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EntityEmail`	`build()` Returns an instance of the object being built by this builder based on the current state of the builder.
`static EntityEmail.Builder`	`create()`
`static EntityEmail.Builder`	`create(EntityEmailContract contract)`
`String`	`getEmailAddress()` Gets this `EntityEmail`'s email address.
`String`	`getEmailAddressUnmasked()` Gets this `EntityEmail`'s unmasked email address.
`CodedAttribute.Builder`	`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.
`void`	`setActive(boolean active)`
`void`	`setDefaultValue(boolean defaultValue)`
`void`	`setEmailAddress(String emailAddress)`
`void`	`setEmailType(CodedAttribute.Builder emailType)`
`void`	`setEntityId(String entityId)`
`void`	`setEntityTypeCode(String entityTypeCode)`
`void`	`setId(String id)`
`void`	`setObjectId(String objectId)`
`void`	`setVersionNumber(Long versionNumber)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - create
```
public static EntityEmail.Builder create()
```
  - create
```
public static EntityEmail.Builder create(EntityEmailContract contract)
```
  - build
```
public EntityEmail build()
```
    Description copied from interface: ModelBuilder
    
    Returns an instance of the object being built by this builder based on the current state of the builder. It should be possible to invoke this method more than once on the same builder. It should never return null;
    
    Specified by:
    
    build in interface ModelBuilder
    
    Returns:
    
    an instance of the object being built by this builder, should never return null
  - 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
  - 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
  - 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
  - getEmailType
```
public CodedAttribute.Builder 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.
  - setId
```
public void setId(String id)
```
  - setEntityTypeCode
```
public void setEntityTypeCode(String entityTypeCode)
```
  - setEntityId
```
public void setEntityId(String entityId)
```
  - setEmailType
```
public void setEmailType(CodedAttribute.Builder emailType)
```
  - setEmailAddress
```
public void setEmailAddress(String emailAddress)
```
  - setDefaultValue
```
public void setDefaultValue(boolean defaultValue)
```
  - setVersionNumber
```
public void setVersionNumber(Long versionNumber)
```
  - setObjectId
```
public void setObjectId(String objectId)
```
  - setActive
```
public void setActive(boolean active)
```

Class EntityEmail.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

create

build

getId

getEntityTypeCode

getEntityId

getEmailType

getEmailAddress

getEmailAddressUnmasked

isSuppressEmail

isDefaultValue

getVersionNumber

getObjectId

isActive

setId

setEntityTypeCode

setEntityId

setEmailType

setEmailAddress

setDefaultValue

setVersionNumber

setObjectId

setActive