com.edustructures.sifworks.infra
Class SIF_Contexts

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<SIF_Context>
                  com.edustructures.sifworks.infra.SIF_Contexts

All Implemented Interfaces:

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

public class SIF_Contexts
extends SIFKeyedList<SIF_Context>

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

SIF_Contexts()
Constructor

SIF_Contexts(SIF_Context sifContext)
Constructor that accepts values for all mandatory fields

Method Summary

void	addSIF_Context(java.lang.String value) Adds a new <SIF_Context> repeatable element.
SIF_Context	getSIF_Context(java.lang.String value) Gets a SIF_Context object instance.
SIF_Context[]	getSIF_Contexts() Gets all SIF_Context object instances.
void	removeSIF_Context(java.lang.String value) Removes a SIF_Context object instance.
void	setSIF_Contexts(SIF_Context[] sif_contexts) Sets an array of SIF_Context 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

SIF_Contexts

public SIF_Contexts()

Constructor

SIF_Contexts

public SIF_Contexts(SIF_Context sifContext)

Constructor that accepts values for all mandatory fields

Parameters:

sifContext - Each SIF Context that applies to the message. If none is specified, the applicable context is Default.

Method Detail

addSIF_Context

public void addSIF_Context(java.lang.String value)

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

Parameters:

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

Since:

2.0

removeSIF_Context

public void removeSIF_Context(java.lang.String value)

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

Parameters:

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

Since:

2.0

getSIF_Context

public SIF_Context getSIF_Context(java.lang.String value)

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

Parameters:

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

Returns:

A SIF_Context object

Since:

2.0

getSIF_Contexts

public SIF_Context[] getSIF_Contexts()

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

Returns:

An array of SIF_Context objects

Since:

2.0

setSIF_Contexts

public void setSIF_Contexts(SIF_Context[] sif_contexts)

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

Since:

2.0