com.edustructures.sifworks.common
Class OtherCodeList

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<OtherCode>
                  com.edustructures.sifworks.common.OtherCodeList

All Implemented Interfaces:

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

public class OtherCodeList
extends SIFKeyedList<OtherCode>

Since:

2.0

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

OtherCodeList()
Constructor

OtherCodeList(OtherCode otherCode)
Constructor that accepts values for all mandatory fields

Method Summary

void	addOtherCode(Codeset codeset, java.lang.String value) Adds a new <OtherCode> repeatable element.
OtherCode	getOtherCode(Codeset codeset) Gets an OtherCode object instance.
OtherCode[]	getOtherCodes() Gets all OtherCode object instances.
void	removeOtherCode(Codeset codeset) Removes an OtherCode object instance.
void	setOtherCodes(OtherCode[] othercodes) Sets an array of OtherCode 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

OtherCodeList

public OtherCodeList()

Constructor

OtherCodeList

public OtherCodeList(OtherCode otherCode)

Constructor that accepts values for all mandatory fields

Parameters:

otherCode - A state/province code, local code, other code or a text string that crosswalks to or serves as a translation of an associated Code element.

Method Detail

addOtherCode

public void addOtherCode(Codeset codeset,
                         java.lang.String value)

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

Parameters:

codeset - Describes the OtherCode element content as either a state/province code, a local code, other code, or text string.

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

Since:

2.0

removeOtherCode

public void removeOtherCode(Codeset codeset)

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

Parameters:

codeset - Identifies the OtherCode object to remove by its Codeset value

Since:

2.0

getOtherCode

public OtherCode getOtherCode(Codeset codeset)

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

Parameters:

codeset - Identifies the OtherCode object to return by its "Codeset" attribute value

Returns:

An OtherCode object

Since:

2.0

getOtherCodes

public OtherCode[] getOtherCodes()

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

Returns:

An array of OtherCode objects

Since:

2.0

setOtherCodes

public void setOtherCodes(OtherCode[] othercodes)

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

Since:

2.0