com.edustructures.sifworks.common
Class EmailList

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<T>
                  com.edustructures.sifworks.SIFActionList<Email>
                      com.edustructures.sifworks.common.EmailList

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<Email>, java.util.Collection<Email>

public class EmailList
extends SIFActionList<Email>

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

EmailList()
Constructor

EmailList(Email email)
Constructor that accepts values for all mandatory fields

Method Summary

void	addEmail(EmailType type, java.lang.String value) Adds a new <Email> repeatable element.
Email	getEmail(EmailType type) Gets an Email object instance.
Email[]	getEmails() Gets all Email object instances.
void	removeEmail(EmailType type) Removes an Email object instance.
void	setEmails(Email[] emails) Sets an array of Email objects.

Methods inherited from class com.edustructures.sifworks.SIFKeyedList

getChild, getChild

Methods inherited from class com.edustructures.sifworks.SIFList

add, addAll, clear, contains, containsAll, get, iterator, remove, remove, removeAll, retainAll, size, toArray, toArray

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, clone, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getKey, 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

Methods inherited from interface java.util.Collection

equals, hashCode, isEmpty

Constructor Detail

EmailList

public EmailList()

Constructor

EmailList

public EmailList(Email email)

Constructor that accepts values for all mandatory fields

Parameters:

email - The employee's email.For a description of this element, see 5.1.8 Email.

Method Detail

addEmail

public void addEmail(EmailType type,
                     java.lang.String value)

Adds a new <Email> repeatable element. This form of setEmail is provided as a convenience method that is functionally equivalent to the version of setEmail that accepts a single Email object.

Parameters:

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

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

Since:

1.1

removeEmail

public void removeEmail(EmailType type)

Removes an Email object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:

type - Identifies the Email object to remove by its Type value

Since:

1.1

getEmail

public Email getEmail(EmailType type)

Gets an Email object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:

type - Identifies the Email object to return by its "Type" attribute value

Returns:

An Email object

Since:

1.1

getEmails

public Email[] getEmails()

Gets all Email object instances. More than one instance can be defined for this object because it is a repeatable field element.

Returns:

An array of Email objects

Since:

1.1

setEmails

public void setEmails(Email[] emails)

Sets an array of Email objects. All existing Email instances are removed and replaced with this list. Calling this method with the parameter value set to null removes all Emails.

Since:

1.1