com.edustructures.sifworks.assessment
Class SpecialConditions

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<T>
                  com.edustructures.sifworks.SIFActionList<SpecialCondition>
                      com.edustructures.sifworks.assessment.SpecialConditions

All Implemented Interfaces:

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

public class SpecialConditions
extends SIFActionList<SpecialCondition>

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

SpecialConditions()
Constructor

SpecialConditions(SpecialCondition specialCondition)
Constructor that accepts values for all mandatory fields

Method Summary

void	addSpecialCondition(java.lang.String code, java.lang.String value) Adds a new <SpecialCondition> repeatable element.
SpecialCondition	getSpecialCondition(java.lang.String code) Gets a SpecialCondition object instance.
SpecialCondition[]	getSpecialConditions() Gets all SpecialCondition object instances.
void	removeSpecialCondition(java.lang.String code) Removes a SpecialCondition object instance.
void	setSpecialConditions(SpecialCondition[] specialconditions) Sets an array of SpecialCondition 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

SpecialConditions

public SpecialConditions()

Constructor

SpecialConditions

public SpecialConditions(SpecialCondition specialCondition)

Constructor that accepts values for all mandatory fields

Parameters:

specialCondition - A text description of the special condition.

Method Detail

addSpecialCondition

public void addSpecialCondition(java.lang.String code,
                                java.lang.String value)

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

Parameters:

code - This is the primary key for the list of special conditions.

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

Since:

2.0

removeSpecialCondition

public void removeSpecialCondition(java.lang.String code)

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

Parameters:

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

Since:

2.0

getSpecialCondition

public SpecialCondition getSpecialCondition(java.lang.String code)

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

Parameters:

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

Returns:

A SpecialCondition object

Since:

2.0

getSpecialConditions

public SpecialCondition[] getSpecialConditions()

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

Returns:

An array of SpecialCondition objects

Since:

2.0

setSpecialConditions

public void setSpecialConditions(SpecialCondition[] specialconditions)

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

Since:

2.0