com.edustructures.sifworks.common
Class PhoneNumberList

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<PhoneNumber>
                      com.edustructures.sifworks.common.PhoneNumberList

All Implemented Interfaces:

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

public class PhoneNumberList
extends SIFActionList<PhoneNumber>

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

PhoneNumberList()
Constructor

PhoneNumberList(PhoneNumber phoneNumber)
Constructor that accepts values for all mandatory fields

Method Summary

void	addPhoneNumber(PhoneNumberType type, java.lang.String number) Adds a new <PhoneNumber> repeatable element.
PhoneNumber	getPhoneNumber(PhoneNumberType type) Gets a PhoneNumber object instance.
PhoneNumber[]	getPhoneNumbers() Gets all PhoneNumber object instances.
void	removePhoneNumber(PhoneNumberType type) Removes a PhoneNumber object instance.
void	setPhoneNumbers(PhoneNumber[] phonenumbers) Sets an array of PhoneNumber 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

PhoneNumberList

public PhoneNumberList()

Constructor

PhoneNumberList

public PhoneNumberList(PhoneNumber phoneNumber)

Constructor that accepts values for all mandatory fields

Parameters:

phoneNumber - This element contains the employee's phone number.For a description of this element, see 5.1.22 PhoneNumber.

Method Detail

addPhoneNumber

public void addPhoneNumber(PhoneNumberType type,
                           java.lang.String number)

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

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:

Since:

1.1

removePhoneNumber

public void removePhoneNumber(PhoneNumberType type)

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

Parameters:

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

Since:

1.1

getPhoneNumber

public PhoneNumber getPhoneNumber(PhoneNumberType type)

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

Parameters:

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

Returns:

A PhoneNumber object

Since:

1.1

getPhoneNumbers

public PhoneNumber[] getPhoneNumbers()

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

Returns:

An array of PhoneNumber objects

Since:

1.1

setPhoneNumbers

public void setPhoneNumbers(PhoneNumber[] phonenumbers)

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

Since:

1.1