com.edustructures.sifworks.common
Class PhoneNumber

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.common.PhoneNumber

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class PhoneNumber
extends SIFKeyedElement

A telephone number

Since:

1.1

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

PhoneNumber()
Constructor

PhoneNumber(PhoneNumberType type, java.lang.String number)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getExtension() Gets the value of the <Extension> element.
java.lang.String	getFormat() Gets the value of the Format attribute.
java.lang.String	getKey() Gets the key of this object
ElementDef[]	getKeyFields() Gets the metadata fields that make up the key of this object
java.lang.String	getListedStatus() Gets the value of the <ListedStatus> element.
java.lang.String	getNumber() Gets the value of the <Number> element.
java.lang.String	getType() Gets the value of the Type attribute.
void	setExtension(java.lang.String value) Sets the value of the <Extension> element.
void	setFormat(PhoneNumberFormat value) Sets the value of the Format attribute.
void	setFormat(java.lang.String value) Sets the value of the Format attribute as a String.
void	setListedStatus(ListedStatus value) Sets the value of the <ListedStatus> element.
void	setListedStatus(java.lang.String value) Sets the value of the <ListedStatus> element as a String.
void	setNumber(java.lang.String value) Sets the value of the <Number> element.
void	setType(PhoneNumberType value) Sets the value of the Type attribute.
void	setType(java.lang.String value) Sets the value of the Type attribute as a String.

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, clone, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getSIFValue, getSIFVersion, getTextValue, getXmlId, hasTextValue, removeChild, removeChild, removeChild, removeChild, restoreImplementationDef, setChanged, setChildren, setEmpty, setField, setField, setField, setField, setSIFValue, setSIFVersion, setTextValue, setXmlId, tag

Methods inherited from class com.edustructures.sifworks.Element

compareTo, getElementDef, getParent, getRoot, isChanged, isDoNotEncode, isEmpty, setChanged, setDoNotEncode, setElementDef, setEmpty, setParent, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PhoneNumber

public PhoneNumber()

Constructor

PhoneNumber

public PhoneNumber(PhoneNumberType type,
                   java.lang.String number)

Constructor that accepts values for all mandatory fields

Parameters:

type - Code that specifies what type of phone number this is. Note: A subset of valid values may be specified in data objects.

number - Phone number. Acceptable formats:

Method Detail

getKey

public java.lang.String getKey()

Gets the key of this object

Overrides:

getKey in class SIFElement

Returns:

The value of the object's Mandatory or Required attribute. If an object has more than one such attribute, the key is a period- delimited concatenation of the attribute values in sequential order

getKeyFields

public ElementDef[] getKeyFields()

Gets the metadata fields that make up the key of this object

Returns:

an array of metadata fields that make up the object's key

getFormat

public java.lang.String getFormat()

Gets the value of the Format attribute.

The SIF specification defines the meaning of this attribute as: "A code that specifies the format of this phone number"

Returns:

The Format attribute of this object.

Since:

1.1

setFormat

public void setFormat(PhoneNumberFormat value)

Sets the value of the Format attribute.

The SIF specification defines the meaning of this attribute as: "A code that specifies the format of this phone number"

Parameters:

value - A constant defined by the PhoneNumberFormat class

Since:

1.1

setFormat

public void setFormat(java.lang.String value)

Sets the value of the Format attribute as a String.

The SIF specification defines the meaning of this attribute as: "A code that specifies the format of this phone number"

Parameters:

value - The value as a String

Since:

1.1

getType

public java.lang.String getType()

Gets the value of the Type attribute.

The SIF specification defines the meaning of this attribute as: "Code that specifies what type of phone number this is. Note: A subset of valid values may be specified in data objects."

Returns:

The Type attribute of this object.

Since:

1.1

setType

public void setType(PhoneNumberType value)

Sets the value of the Type attribute.

The SIF specification defines the meaning of this attribute as: "Code that specifies what type of phone number this is. Note: A subset of valid values may be specified in data objects."

Parameters:

value - A constant defined by the PhoneNumberType class

Since:

1.1

setType

public void setType(java.lang.String value)

Sets the value of the Type attribute as a String.

The SIF specification defines the meaning of this attribute as: "Code that specifies what type of phone number this is. Note: A subset of valid values may be specified in data objects."

Parameters:

value - The value as a String

Since:

1.1

getNumber

public java.lang.String getNumber()

Gets the value of the <Number> element.

The SIF specification defines the meaning of this element as: "Phone number. Acceptable formats:"

Returns:

The Number element of this object.

Since:

2.0

setNumber

public void setNumber(java.lang.String value)

Sets the value of the <Number> element.

The SIF specification defines the meaning of this element as: "Phone number. Acceptable formats:"

Parameters:

value - A String object

Since:

2.0

getExtension

public java.lang.String getExtension()

Gets the value of the <Extension> element.

The SIF specification defines the meaning of this element as: "Phone number extension."

Returns:

The Extension element of this object.

Since:

2.0

setExtension

public void setExtension(java.lang.String value)

Sets the value of the <Extension> element.

The SIF specification defines the meaning of this element as: "Phone number extension."

Parameters:

value - A String object

Since:

2.0

getListedStatus

public java.lang.String getListedStatus()

Gets the value of the <ListedStatus> element.

The SIF specification defines the meaning of this element as: "Indicates whether or not the phone number is available to the public."

Returns:

The ListedStatus element of this object.

Since:

2.0

setListedStatus

public void setListedStatus(ListedStatus value)

Sets the value of the <ListedStatus> element.

The SIF specification defines the meaning of this element as: "Indicates whether or not the phone number is available to the public."

Parameters:

value - A constant defined by the ListedStatus class

Since:

2.0

setListedStatus

public void setListedStatus(java.lang.String value)

Sets the value of the <ListedStatus> element as a String.

The SIF specification defines the meaning of this element as: "Indicates whether or not the phone number is available to the public."

Parameters:

value - The value as a String

Since:

2.0