com.edustructures.sifworks.instr
Class Components

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFList<Component>
              com.edustructures.sifworks.instr.Components

All Implemented Interfaces:

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

public class Components
extends SIFList<Component>

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

Components()
Constructor

Components(Component component)
Constructor that accepts values for all mandatory fields

Method Summary

void	addComponent(java.lang.String name, java.lang.String reference) Adds a new <Component> repeatable element.
Component	getComponent(java.lang.String name, java.lang.String reference) Gets a Component object instance.
Component[]	getComponents() Gets all Component object instances.
void	removeComponent(java.lang.String name, java.lang.String reference) Removes a Component object instance.
void	setComponents(Component[] components) Sets an array of Component objects.

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, 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

Components

public Components()

Constructor

Components

public Components(Component component)

Constructor that accepts values for all mandatory fields

Parameters:

component -

Method Detail

addComponent

public void addComponent(java.lang.String name,
                         java.lang.String reference)

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

Parameters:

name - Name of learning resource component within the resource, i.e. "Chapter 1, Section 4.

reference - Description of where ResourceComponent is located within resource or in general, i.e. "Section 4, pages 32-38," or URL string, or whatever locator is appropriate for media.

Since:

2.0

removeComponent

public void removeComponent(java.lang.String name,
                            java.lang.String reference)

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

Parameters:

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

reference - Identifies the Component object to remove by its Reference value

Since:

2.0

getComponent

public Component getComponent(java.lang.String name,
                              java.lang.String reference)

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

Parameters:

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

reference - Identifies the Component object to return by its "Reference" attribute value

Returns:

A Component object

Since:

2.0

getComponents

public Component[] getComponents()

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

Returns:

An array of Component objects

Since:

2.0

setComponents

public void setComponents(Component[] components)

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

Since:

2.0