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

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

All Implemented Interfaces:

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

public final class EntityPhone
extends Object
implements ModelObjectComplete, EntityPhoneContract

See Also:

Serialized Form

Nested Class Summary

static class	EntityPhone.Builder A builder which can be used to construct EntityPhone instances.
(package private) static class	EntityPhone.Constants Defines some internal constants used on this class.
(package private) static class	EntityPhone.Elements A private class which exposes constants which define the XML element names to use when this object is marshalled to XML.

Field Summary

private Collection<Element>	_futureElements
private boolean	active
private String	countryCode
private String	countryCodeUnmasked
private boolean	defaultValue
private String	entityId
private String	entityTypeCode
private String	extensionNumber
private String	extensionNumberUnmasked
private String	formattedPhoneNumber
private String	formattedPhoneNumberUnmasked
private String	id
private String	objectId
private String	phoneNumber
private String	phoneNumberUnmasked
private Type	phoneType
private boolean	suppressPhone
private Long	versionNumber

Constructor Summary

private	EntityPhone() Private constructor used only by JAXB.
private	EntityPhone(EntityPhone.Builder builder)

Method Summary

boolean	equals(Object object) All "Complete" model object's should adhere to the ModelObjectComplete.equals(Object) 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.
Type	getPhoneType() Gets this EntityPhone's type code.
Long	getVersionNumber() Returns the version number for this object.
int	hashCode() All "Complete" model object's should adhere to the ModelObjectComplete.hashCode() contract.
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.
String	toString() This will return a proper string representation of the Model Object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

id

private final String id

entityTypeCode

private final String entityTypeCode

entityId

private final String entityId

phoneType

private final Type phoneType

phoneNumber

private final String phoneNumber

extensionNumber

private final String extensionNumber

countryCode

private final String countryCode

phoneNumberUnmasked

private final String phoneNumberUnmasked

extensionNumberUnmasked

private final String extensionNumberUnmasked

countryCodeUnmasked

private final String countryCodeUnmasked

formattedPhoneNumber

private final String formattedPhoneNumber

formattedPhoneNumberUnmasked

private final String formattedPhoneNumberUnmasked

suppressPhone

private final boolean suppressPhone

defaultValue

private final boolean defaultValue

versionNumber

private final Long versionNumber

objectId

private final String objectId

active

private final boolean active

_futureElements

private final Collection<Element> _futureElements

Constructor Detail

EntityPhone

private EntityPhone()

Private constructor used only by JAXB.

EntityPhone

private EntityPhone(EntityPhone.Builder builder)

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: EntityPhoneContract

Gets this id of the parent identity object.

Specified by:

getEntityId in interface EntityPhoneContract

Returns:

the identity id for this EntityPhoneContract

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

getPhoneType

public Type 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.

hashCode

public int hashCode()

Description copied from interface: ModelObjectComplete

All "Complete" model object's should adhere to the ModelObjectComplete.hashCode() contract.

Specified by:

hashCode in interface ModelObjectComplete

Overrides:

hashCode in class Object

Returns:

the hashCode value

equals

public boolean equals(Object object)

Description copied from interface: ModelObjectComplete

All "Complete" model object's should adhere to the ModelObjectComplete.equals(Object) contract.

Specified by:

equals in interface ModelObjectComplete

Overrides:

equals in class Object

Parameters:

object - to object to compare for equality

Returns:

if equal

toString

public String toString()

Description copied from interface: ModelObjectBasic

This will return a proper string representation of the Model Object. All of the fields comprising the "public" api should be represented in the return value.

Specified by:

toString in interface ModelObjectBasic

Overrides:

toString in class Object

Returns:

the string representation