EntityPhone.Builder (Rice 2.2.1-SNAPSHOT API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.kuali.rice.kim.api.identity.phone
Class EntityPhone.Builder

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
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
`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