com.edustructures.sifworks.datamodel
Class TimeElements

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<TimeElement>
                  com.edustructures.sifworks.datamodel.TimeElements

All Implemented Interfaces:

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

public class TimeElements
extends SIFKeyedList<TimeElement>

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

TimeElements()
Constructor

TimeElements(TimeElement timeElement)
Constructor that accepts values for all mandatory fields

Method Summary

void	addTimeElement(TimeElementType type, java.lang.String code, java.lang.String name, java.lang.String value) Adds a new <TimeElement> repeatable element.
TimeElement	getTimeElement(java.lang.String code) Gets a TimeElement object instance.
TimeElement[]	getTimeElements() Gets all TimeElement object instances.
void	removeTimeElement(java.lang.String code) Removes a TimeElement object instance.
void	setTimeElements(TimeElement[] timeelements) Sets an array of TimeElement 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

TimeElements

public TimeElements()

Constructor

TimeElements

public TimeElements(TimeElement timeElement)

Constructor that accepts values for all mandatory fields

Parameters:

timeElement -

Method Detail

addTimeElement

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

Adds a new <TimeElement> repeatable element. This form of setTimeElement is provided as a convenience method that is functionally equivalent to the version of setTimeElement that accepts a single TimeElement 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

removeTimeElement

public void removeTimeElement(java.lang.String code)

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

Parameters:

code - Identifies the TimeElement object to remove by its Code value

Since:

2.0

getTimeElement

public TimeElement getTimeElement(java.lang.String code)

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

Parameters:

code - Identifies the TimeElement object to return by its "Code" attribute value

Returns:

A TimeElement object

Since:

2.0

getTimeElements

public TimeElement[] getTimeElements()

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

Returns:

An array of TimeElement objects

Since:

2.0

setTimeElements

public void setTimeElements(TimeElement[] timeelements)

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

Since:

2.0