com.edustructures.sifworks.common
Class Email

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class Email
extends SIFKeyedElement

This element represents an e-mail address of one of a number of types and occurs in objects such as StudentPersonal, StaffPersonal, StudentContact, etc.

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

Email()
Constructor

Email(EmailType type, java.lang.String value)
Constructor that accepts values for all mandatory fields

Method Summary

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	getType() Gets the value of the Type attribute.
java.lang.String	getValue() Gets the value of the <Value> element.
void	setType(EmailType value) Sets the value of the Type attribute.
void	setType(java.lang.String value) Sets the value of the Type attribute as a String.
void	setValue(java.lang.String value) Sets the value of the <Value> element.

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

Email

public Email()

Constructor

Email

public Email(EmailType type,
             java.lang.String value)

Constructor that accepts values for all mandatory fields

Parameters:

type - This attribute specifies the type of e-mail address.

value - Gets or sets the content value of the <Email> element

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

getValue

public java.lang.String getValue()

Gets the value of the <Value> element.

The SIF specification defines the meaning of this element as: "Gets or sets the content value of the <Email> element"

Returns:

The Value element of this object.

Since:

1.1

setValue

public void setValue(java.lang.String value)

Sets the value of the <Value> element.

The SIF specification defines the meaning of this element as: "Gets or sets the content value of the <Email> element"

Parameters:

value - A String object

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: "This attribute specifies the type of e-mail address."

Returns:

The Type attribute of this object.

Since:

1.1

setType

public void setType(EmailType value)

Sets the value of the Type attribute.

The SIF specification defines the meaning of this attribute as: "This attribute specifies the type of e-mail address."

Parameters:

value - A constant defined by the EmailType 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: "This attribute specifies the type of e-mail address."

Parameters:

value - The value as a String

Since:

1.1