com.edustructures.sifworks.common
Class CountriesOfResidency

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<Country>
                  com.edustructures.sifworks.common.CountriesOfResidency

All Implemented Interfaces:

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

public class CountriesOfResidency
extends SIFKeyedList<Country>

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

CountriesOfResidency()
Constructor

CountriesOfResidency(Country countryOfResidency)
Constructor that accepts values for all mandatory fields

Method Summary

void	addCountryOfResidency(CountryCode value) Adds a new <CountryOfResidency> repeatable element.
Country	getCountryOfResidency(CountryCode value) Gets a Country object instance.
Country[]	getCountryOfResidencys() Gets all Country object instances.
void	removeCountryOfResidency(CountryCode value) Removes a Country object instance.
void	setCountryOfResidencys(Country[] countryofresidencys) Sets an array of Country 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

CountriesOfResidency

public CountriesOfResidency()

Constructor

CountriesOfResidency

public CountriesOfResidency(Country countryOfResidency)

Constructor that accepts values for all mandatory fields

Parameters:

countryOfResidency - A person's country of residence.

Method Detail

addCountryOfResidency

public void addCountryOfResidency(CountryCode value)

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

Parameters:

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

Since:

1.1

removeCountryOfResidency

public void removeCountryOfResidency(CountryCode value)

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

Parameters:

value - Identifies the Country object to remove by its Value value

Since:

1.1

getCountryOfResidency

public Country getCountryOfResidency(CountryCode value)

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

Parameters:

value - Identifies the Country object to return by its "Value" attribute value

Returns:

A Country object

Since:

1.1

getCountryOfResidencys

public Country[] getCountryOfResidencys()

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

Returns:

An array of Country objects

Since:

1.1

setCountryOfResidencys

public void setCountryOfResidencys(Country[] countryofresidencys)

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

Since:

1.1