com.edustructures.sifworks.instr
Class EssentialMaterials

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<T>
              com.edustructures.sifworks.SIFKeyedList<EssentialMaterial>
                  com.edustructures.sifworks.instr.EssentialMaterials

All Implemented Interfaces:

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

public class EssentialMaterials
extends SIFKeyedList<EssentialMaterial>

Since:

1.5r1

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

EssentialMaterials()
Constructor

EssentialMaterials(EssentialMaterial essentialMaterial)
Constructor that accepts values for all mandatory fields

Method Summary

void	addEssentialMaterial(java.lang.String value) Adds a new <EssentialMaterial> repeatable element.
EssentialMaterial	getEssentialMaterial(java.lang.String value) Gets an EssentialMaterial object instance.
EssentialMaterial[]	getEssentialMaterials() Gets all EssentialMaterial object instances.
void	removeEssentialMaterial(java.lang.String value) Removes an EssentialMaterial object instance.
void	setEssentialMaterials(EssentialMaterial[] essentialmaterials) Sets an array of EssentialMaterial 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

EssentialMaterials

public EssentialMaterials()

Constructor

EssentialMaterials

public EssentialMaterials(EssentialMaterial essentialMaterial)

Constructor that accepts values for all mandatory fields

Parameters:

essentialMaterial - Essential material required to engage in this activity.

Method Detail

addEssentialMaterial

public void addEssentialMaterial(java.lang.String value)

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

Parameters:

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

Since:

1.5r1

removeEssentialMaterial

public void removeEssentialMaterial(java.lang.String value)

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

Parameters:

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

Since:

1.5r1

getEssentialMaterial

public EssentialMaterial getEssentialMaterial(java.lang.String value)

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

Parameters:

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

Returns:

An EssentialMaterial object

Since:

1.5r1

getEssentialMaterials

public EssentialMaterial[] getEssentialMaterials()

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

Returns:

An array of EssentialMaterial objects

Since:

1.5r1

setEssentialMaterials

public void setEssentialMaterials(EssentialMaterial[] essentialmaterials)

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

Since:

1.5r1