com.edustructures.sifworks.common
Class OtherIdList

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<OtherId>
                  com.edustructures.sifworks.common.OtherIdList

All Implemented Interfaces:

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

public class OtherIdList
extends SIFKeyedList<OtherId>

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

OtherIdList()
Constructor

OtherIdList(OtherId otherId)
Constructor that accepts values for all mandatory fields

Method Summary

void	addOtherId(OtherIdType type, java.lang.String value) Adds a new <OtherId> repeatable element.
OtherId	getOtherId(OtherIdType type) Gets an OtherId object instance.
OtherId[]	getOtherIds() Gets all OtherId object instances.
void	removeOtherId(OtherIdType type) Removes an OtherId object instance.
void	setOtherIds(OtherId[] otherids) Sets an array of OtherId 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

OtherIdList

public OtherIdList()

Constructor

OtherIdList

public OtherIdList(OtherId otherId)

Constructor that accepts values for all mandatory fields

Parameters:

otherId - Codes that define valid types for OtherId elements

Method Detail

addOtherId

public void addOtherId(OtherIdType type,
                       java.lang.String value)

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

Parameters:

type - Code that defines the type of this other ID. Note: A subset of valid values may be specified in data objects.

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

Since:

1.1

removeOtherId

public void removeOtherId(OtherIdType type)

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

Parameters:

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

Since:

1.1

getOtherId

public OtherId getOtherId(OtherIdType type)

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

Parameters:

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

Returns:

An OtherId object

Since:

1.1

getOtherIds

public OtherId[] getOtherIds()

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

Returns:

An array of OtherId objects

Since:

1.1

setOtherIds

public void setOtherIds(OtherId[] otherids)

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

Since:

1.1