com.edustructures.sifworks.instr
Class ComponentObjects

java.lang.Object
  extended by com.edustructures.sifworks.Element
      extended by com.edustructures.sifworks.SIFElement
          extended by com.edustructures.sifworks.SIFList<T>
              extended by com.edustructures.sifworks.SIFKeyedList<ComponentObject>
                  extended by com.edustructures.sifworks.instr.ComponentObjects
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<ComponentObject>, java.util.Collection<ComponentObject>

public class ComponentObjects
extends SIFKeyedList<ComponentObject>

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
ComponentObjects()
          Constructor
ComponentObjects(ComponentObject componentObject)
          Constructor that accepts values for all mandatory fields
 
Method Summary
 void addComponentObject(java.lang.String sifRefObject, java.lang.String value)
          Adds a new <ComponentObject> repeatable element.
 ComponentObject getComponentObject(java.lang.String sifRefObject)
          Gets a ComponentObject object instance.
 ComponentObject[] getComponentObjects()
          Gets all ComponentObject object instances.
 void removeComponentObject(java.lang.String sifRefObject)
          Removes a ComponentObject object instance.
 void setComponentObjects(ComponentObject[] componentobjects)
          Sets an array of ComponentObject 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

ComponentObjects

public ComponentObjects()
Constructor


ComponentObjects

public ComponentObjects(ComponentObject componentObject)
Constructor that accepts values for all mandatory fields

Parameters:
componentObject -
Method Detail

addComponentObject

public void addComponentObject(java.lang.String sifRefObject,
                               java.lang.String value)
Adds a new <ComponentObject> repeatable element. This form of setComponentObject is provided as a convenience method that is functionally equivalent to the version of setComponentObject that accepts a single ComponentObject object.

Parameters:
sifRefObject - The type of learning object being referenced.
value - Gets or sets the content value of the <ComponentObject> element
Since:
1.5r1

removeComponentObject

public void removeComponentObject(java.lang.String sifRefObject)
Removes a ComponentObject object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:
sifRefObject - Identifies the ComponentObject object to remove by its SIF_RefObject value
Since:
1.5r1

getComponentObject

public ComponentObject getComponentObject(java.lang.String sifRefObject)
Gets a ComponentObject object instance. More than one instance can be defined for this object because it is a repeatable field element.

Parameters:
sifRefObject - Identifies the ComponentObject object to return by its "SIF_RefObject" attribute value
Returns:
A ComponentObject object
Since:
1.5r1

getComponentObjects

public ComponentObject[] getComponentObjects()
Gets all ComponentObject object instances. More than one instance can be defined for this object because it is a repeatable field element.

Returns:
An array of ComponentObject objects
Since:
1.5r1

setComponentObjects

public void setComponentObjects(ComponentObject[] componentobjects)
Sets an array of ComponentObject objects. All existing ComponentObject instances are removed and replaced with this list. Calling this method with the parameter value set to null removes all ComponentObjects.

Since:
1.5r1


Copyright © 2001-2007 Edustructures LLC. All Rights Reserved. SIFWorks® and ADK® are registered trademarks of Edustructures LLC. SIF™ and Schools Interoperability Framework are trademarks of the Schools Interoperability Framework Association.