com.edustructures.sifworks.datamodel
Class SpanGaps

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<SpanGap>
              com.edustructures.sifworks.datamodel.SpanGaps

All Implemented Interfaces:

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

public class SpanGaps
extends SIFList<SpanGap>

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

SpanGaps()
Constructor

SpanGaps(SpanGap spanGap)
Constructor that accepts values for all mandatory fields

Method Summary

void	addSpanGap(TimeElementType type, java.lang.String code, java.lang.String name, java.lang.String value) Adds a new <SpanGap> repeatable element.
SpanGap[]	getSpanGaps() Gets all SpanGap object instances.
void	setSpanGaps(SpanGap[] spangaps) Sets an array of SpanGap objects.

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, 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

SpanGaps

public SpanGaps()

Constructor

SpanGaps

public SpanGaps(SpanGap spanGap)

Constructor that accepts values for all mandatory fields

Parameters:

spanGap -

Method Detail

addSpanGap

public void addSpanGap(TimeElementType type,
                       java.lang.String code,
                       java.lang.String name,
                       java.lang.String value)

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

Parameters:

type -

code - This element provides a place for the application to send structured data (code values, unique identifier, timestamps). This code value can, depending upon the use case agreement between agents, be used to qualify the data in the Value element.

name - Contains a human-readable description of the value in Value.

value - Contains the human-readable value.

Since:

2.0

getSpanGaps

public SpanGap[] getSpanGaps()

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

Returns:

An array of SpanGap objects

Since:

2.0

setSpanGaps

public void setSpanGaps(SpanGap[] spangaps)

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

Since:

2.0