com.edustructures.sifworks.common
Class AddressList

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<Address>
                      com.edustructures.sifworks.common.AddressList

All Implemented Interfaces:

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

public class AddressList
extends SIFActionList<Address>

A list of Address elements

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

AddressList()
Constructor

AddressList(Address address)
Constructor that accepts values for all mandatory fields

Method Summary

void	addAddress(AddressType type, Street street, java.lang.String city, StatePrCode stateProvince, CountryCode country, java.lang.String postalCode) Adds a new <Address> repeatable element.
Address	getAddress(AddressType type) Gets an Address object instance.
Address[]	getAddresses() Gets all Address object instances.
void	removeAddress(AddressType type) Removes an Address object instance.
void	setAddresses(Address[] addresses) Sets an array of Address 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

AddressList

public AddressList()

Constructor

AddressList

public AddressList(Address address)

Constructor that accepts values for all mandatory fields

Parameters:

address - This element contains information related to employee's address information.For a description of this element, see 5.1.1 Address.

Method Detail

addAddress

public void addAddress(AddressType type,
                       Street street,
                       java.lang.String city,
                       StatePrCode stateProvince,
                       CountryCode country,
                       java.lang.String postalCode)

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

Parameters:

type - Code that defines the location of the address. Note: A subset of specific valid values for each instance in a data object may be listed in that object.

street - The street part of the address

city - The city part of the address.

stateProvince - The state or province code.

country - The country code.

postalCode - The ZIP/postal code.

Since:

1.1

removeAddress

public void removeAddress(AddressType type)

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

Parameters:

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

Since:

1.1

getAddress

public Address getAddress(AddressType type)

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

Parameters:

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

Returns:

An Address object

Since:

1.1

getAddresses

public Address[] getAddresses()

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

Returns:

An array of Address objects

Since:

1.1

setAddresses

public void setAddresses(Address[] addresses)

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

Since:

1.1