Package org.kuali.rice.kim.api.identity.phone

Class EntityPhone

java.lang.Object

org.kuali.rice.core.api.mo.AbstractDataTransferObject

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 AbstractDataTransferObject
implements EntityPhoneContract

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	EntityPhone.Builder	A builder which can be used to construct EntityPhone instances.

Method Summary

Modifier and Type	Method	Description
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()
String	getObjectId()
String	getPhoneNumber()	Gets this EntityPhone's phone number.
String	getPhoneNumberUnmasked()	Gets this EntityPhone's unmasked phone number.
CodedAttribute	getPhoneType()	Gets this EntityPhone's type code.
Long	getVersionNumber()
boolean	isActive()
boolean	isDefaultValue()
boolean	isSuppressPhone()	Returns a boolean value that determines if phone 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: 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 CodedAttribute 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()

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