EntityPhone.Builder (Rice 2.1.13 API)

java.lang.Object
- org.kuali.rice.kim.api.identity.phone.EntityPhone.Builder

All Implemented Interfaces:

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

Enclosing class:

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

See Also:

Serialized Form

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EntityPhone`	`build()` Returns an instance of the object being built by this builder based on the current state of the builder.
`static EntityPhone.Builder`	`create()`
`static EntityPhone.Builder`	`create(EntityPhoneContract contract)`
`String`	`getCountryCode()` Gets this `EntityPhone`'s country code.
`String`	`getCountryCodeUnmasked()` Gets this `EntityPhone`'s unmasked country code.
`String`	`getEntityId()` Gets this id of the parent identity object.
`String`	`getEntityTypeCode()` Gets this entityTypeCode of the `EntityPhoneContract`'s object.
`String`	`getExtensionNumber()` Gets this `EntityPhone`'s extension number.
`String`	`getExtensionNumberUnmasked()` Gets this `EntityPhone`'s unmasked extension number.
`String`	`getFormattedPhoneNumber()` Gets this `EntityPhone`'s formatted phone number.
`String`	`getFormattedPhoneNumberUnmasked()` Gets this `EntityPhone`'s unmasked formatted phone number.
`String`	`getId()` The unique identifier for an object.
`String`	`getObjectId()` Return the globally unique object id of this object.
`String`	`getPhoneNumber()` Gets this `EntityPhone`'s phone number.
`String`	`getPhoneNumberUnmasked()` Gets this `EntityPhone`'s unmasked phone number.
`CodedAttribute.Builder`	`getPhoneType()` Gets this `EntityPhone`'s type code.
`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`	`isSuppressPhone()` Returns a boolean value that determines if phone fields should be suppressed.
`void`	`setActive(boolean active)`
`void`	`setCountryCode(String countryCode)`
`void`	`setDefaultValue(boolean defaultValue)`
`void`	`setEntityId(String entityId)`
`void`	`setEntityTypeCode(String entityTypeCode)`
`void`	`setExtensionNumber(String extensionNumber)`
`void`	`setId(String id)`
`void`	`setObjectId(String objectId)`
`void`	`setPhoneNumber(String phoneNumber)`
`void`	`setPhoneType(CodedAttribute.Builder phoneType)`
`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 EntityPhone.Builder create()
```
  - create
```
public static EntityPhone.Builder create(EntityPhoneContract contract)
```
  - build
```
public EntityPhone 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: EntityPhoneContract
    
    Gets this entityTypeCode of the EntityPhoneContract's object.
    
    Specified by:
    
    getEntityTypeCode in interface EntityPhoneContract
    
    Returns:
    
    the identity type code for this EntityPhoneContract
  - getEntityId
```
public String getEntityId()
```
    Description copied from interface: EntityPhoneContract
    
    Gets this id of the parent identity object.
    
    Specified by:
    
    getEntityId in interface EntityPhoneContract
    
    Returns:
    
    the identity id for this EntityPhoneContract
  - getPhoneType
```
public CodedAttribute.Builder getPhoneType()
```
    Description copied from interface: EntityPhoneContract
    
    Gets this EntityPhone's type code.
    
    Specified by:
    
    getPhoneType in interface EntityPhoneContract
    
    Returns:
    
    the type code for this EntityPhone, or null if none has been assigned.
  - getPhoneNumber
```
public String getPhoneNumber()
```
    Description copied from interface: EntityPhoneContract
    
    Gets this EntityPhone's phone number.
    
    Specified by:
    
    getPhoneNumber in interface EntityPhoneContract
    
    Returns:
    
    the phone number for this EntityPhone, or null if none has been assigned.
  - getExtensionNumber
```
public String getExtensionNumber()
```
    Description copied from interface: EntityPhoneContract
    
    Gets this EntityPhone's extension number.
    
    Specified by:
    
    getExtensionNumber in interface EntityPhoneContract
    
    Returns:
    
    the extension number for this EntityPhone, or null if none has been assigned.
  - getCountryCode
```
public String getCountryCode()
```
    Description copied from interface: EntityPhoneContract
    
    Gets this EntityPhone's country code.
    
    Specified by:
    
    getCountryCode in interface EntityPhoneContract
    
    Returns:
    
    the country code for this EntityPhone, or null if none has been assigned.
  - getPhoneNumberUnmasked
```
public String getPhoneNumberUnmasked()
```
    Description copied from interface: EntityPhoneContract
    
    Gets this EntityPhone's unmasked phone number.
    
    Specified by:
    
    getPhoneNumberUnmasked in interface EntityPhoneContract
    
    Returns:
    
    the unmasked phone number for this EntityPhone, or null if none has been assigned.
  - getExtensionNumberUnmasked
```
public String getExtensionNumberUnmasked()
```
    Description copied from interface: EntityPhoneContract
    
    Gets this EntityPhone's unmasked extension number.
    
    Specified by:
    
    getExtensionNumberUnmasked in interface EntityPhoneContract
    
    Returns:
    
    the unmasked extension number for this EntityPhone, or null if none has been assigned.
  - getCountryCodeUnmasked
```
public String getCountryCodeUnmasked()
```
    Description copied from interface: EntityPhoneContract
    
    Gets this EntityPhone's unmasked country code.
    
    Specified by:
    
    getCountryCodeUnmasked in interface EntityPhoneContract
    
    Returns:
    
    the unmasked country code for this EntityPhone, or null if none has been assigned.
  - getFormattedPhoneNumber
```
public String getFormattedPhoneNumber()
```
    Description copied from interface: EntityPhoneContract
    
    Gets this EntityPhone's formatted phone number.
    
    Specified by:
    
    getFormattedPhoneNumber in interface EntityPhoneContract
    
    Returns:
    
    the formatted phone number for this EntityPhone, or null if none has been assigned.
  - getFormattedPhoneNumberUnmasked
```
public String getFormattedPhoneNumberUnmasked()
```
    Description copied from interface: EntityPhoneContract
    
    Gets this EntityPhone's unmasked formatted phone number.
    
    Specified by:
    
    getFormattedPhoneNumberUnmasked in interface EntityPhoneContract
    
    Returns:
    
    the unmasked formatted phone number for this EntityPhone, or null if none has been assigned.
  - isSuppressPhone
```
public boolean isSuppressPhone()
```
    Description copied from interface: EntityPhoneContract
    
    Returns a boolean value that determines if phone fields should be suppressed.
    
    Specified by:
    
    isSuppressPhone in interface EntityPhoneContract
    
    Returns:
    
    boolean value that determines if phone 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)
```
  - setPhoneType
```
public void setPhoneType(CodedAttribute.Builder phoneType)
```
  - setPhoneNumber
```
public void setPhoneNumber(String phoneNumber)
```
  - setExtensionNumber
```
public void setExtensionNumber(String extensionNumber)
```
  - setCountryCode
```
public void setCountryCode(String countryCode)
```
  - 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 EntityPhone.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

create

build

getId

getEntityTypeCode

getEntityId

getPhoneType

getPhoneNumber

getExtensionNumber

getCountryCode

getPhoneNumberUnmasked

getExtensionNumberUnmasked

getCountryCodeUnmasked

getFormattedPhoneNumber

getFormattedPhoneNumberUnmasked

isSuppressPhone

isDefaultValue

getVersionNumber

getObjectId

isActive

setId

setEntityTypeCode

setEntityId

setPhoneType

setPhoneNumber

setExtensionNumber

setCountryCode

setDefaultValue

setVersionNumber

setObjectId

setActive