com.edustructures.sifworks.student
Class RelatedToList

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<RelatedTo>
                  com.edustructures.sifworks.student.RelatedToList

All Implemented Interfaces:

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

public class RelatedToList
extends SIFKeyedList<RelatedTo>

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

RelatedToList()
Constructor

RelatedToList(RelatedTo relatedTo)
Constructor that accepts values for all mandatory fields

Method Summary

void	addRelatedTo(RelatedToCode value) Adds a new <RelatedTo> repeatable element.
RelatedTo	getRelatedTo(RelatedToCode value) Gets a RelatedTo object instance.
RelatedTo[]	getRelatedTos() Gets all RelatedTo object instances.
void	removeRelatedTo(RelatedToCode value) Removes a RelatedTo object instance.
void	setRelatedTos(RelatedTo[] relatedtos) Sets an array of RelatedTo 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

RelatedToList

public RelatedToList()

Constructor

RelatedToList

public RelatedToList(RelatedTo relatedTo)

Constructor that accepts values for all mandatory fields

Parameters:

relatedTo - Identifies if incident was related to a specific category.

Method Detail

addRelatedTo

public void addRelatedTo(RelatedToCode value)

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

Parameters:

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

Since:

2.0

removeRelatedTo

public void removeRelatedTo(RelatedToCode value)

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

Parameters:

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

Since:

2.0

getRelatedTo

public RelatedTo getRelatedTo(RelatedToCode value)

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

Parameters:

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

Returns:

A RelatedTo object

Since:

2.0

getRelatedTos

public RelatedTo[] getRelatedTos()

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

Returns:

An array of RelatedTo objects

Since:

2.0

setRelatedTos

public void setRelatedTos(RelatedTo[] relatedtos)

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

Since:

2.0