com.edustructures.sifworks.common
Class SIF_ExtendedElements

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<SIF_ExtendedElement>
                      com.edustructures.sifworks.common.SIF_ExtendedElements

All Implemented Interfaces:

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

public class SIF_ExtendedElements
extends SIFActionList<SIF_ExtendedElement>

The following element is supported at the end of all SIF objects.

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

SIF_ExtendedElements()
Constructor

SIF_ExtendedElements(SIF_ExtendedElement sifExtendedElement)
Constructor that accepts values for all mandatory fields

Method Summary

void	addSIF_ExtendedElement(java.lang.String name, java.lang.String value) Adds a new <SIF_ExtendedElement> repeatable element.
SIF_ExtendedElement	getSIF_ExtendedElement(java.lang.String name) Gets a SIF_ExtendedElement object instance.
SIF_ExtendedElement[]	getSIF_ExtendedElements() Gets all SIF_ExtendedElement object instances.
void	removeSIF_ExtendedElement(java.lang.String name) Removes a SIF_ExtendedElement object instance.
void	setSIF_ExtendedElements(SIF_ExtendedElement[] sif_extendedelements) Sets an array of SIF_ExtendedElement 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_ExtendedElements

public SIF_ExtendedElements()

Constructor

SIF_ExtendedElements

public SIF_ExtendedElements(SIF_ExtendedElement sifExtendedElement)

Constructor that accepts values for all mandatory fields

Parameters:

sifExtendedElement - A name/value pair, the name being contained in the Name attribute, the value being the element content.

Method Detail

addSIF_ExtendedElement

public void addSIF_ExtendedElement(java.lang.String name,
                                   java.lang.String value)

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

Parameters:

name - The name of the extended element. As it is possible that names for extended elements may collide from agent to agent, it is recommended that the names of extended elements be configurable in an agent, or that agents use URIs for the names of extended elements.

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

Since:

1.5r1

removeSIF_ExtendedElement

public void removeSIF_ExtendedElement(java.lang.String name)

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

Parameters:

name - Identifies the SIF_ExtendedElement object to remove by its Name value

Since:

1.5r1

getSIF_ExtendedElement

public SIF_ExtendedElement getSIF_ExtendedElement(java.lang.String name)

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

Parameters:

name - Identifies the SIF_ExtendedElement object to return by its "Name" attribute value

Returns:

A SIF_ExtendedElement object

Since:

1.5r1

getSIF_ExtendedElements

public SIF_ExtendedElement[] getSIF_ExtendedElements()

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

Returns:

An array of SIF_ExtendedElement objects

Since:

1.5r1

setSIF_ExtendedElements

public void setSIF_ExtendedElements(SIF_ExtendedElement[] sif_extendedelements)

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

Since:

1.5r1