com.edustructures.sifworks.instr
Class Component

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.instr.Component

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class Component
extends SIFElement

A lesson or activity-sized portion of a resource.

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

Component()
Constructor

Component(java.lang.String name, java.lang.String reference)
Constructor that accepts values for all mandatory fields

Method Summary

void	addStrategies(Strategies value) Adds a new <Strategies> child element.
AssociatedObjects	getAssociatedObjects() Gets the value of the <AssociatedObjects> element.
java.lang.String	getDescription() Gets the value of the <Description> element.
java.lang.String	getKey() Gets the key of this object
ElementDef[]	getKeyFields() Gets the metadata fields that make up the key of this object
java.lang.String	getName() Gets the value of the <Name> element.
java.lang.String	getReference() Gets the value of the <Reference> element.
Strategies[]	getStrategieses() Gets all Strategies object instances.
void	removeAssociatedObjects() Removes the AssociatedObjects child element previously created by calling setAssociatedObjects
void	setAssociatedObjects(AssociatedObjects value) Sets the value of the <AssociatedObjects> element.
void	setDescription(java.lang.String value) Sets the value of the <Description> element.
void	setName(java.lang.String value) Sets the value of the <Name> element.
void	setReference(java.lang.String value) Sets the value of the <Reference> element.
void	setStrategieses(Strategies[] strategieses) Sets an array of Strategies objects.

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

Constructor Detail

Component

public Component()

Constructor

Component

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

Constructor that accepts values for all mandatory fields

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.

Method Detail

getKey

public java.lang.String getKey()

Gets the key of this object

Overrides:

getKey in class SIFElement

Returns:

The value of the object's Mandatory or Required attribute. If an object has more than one such attribute, the key is a period- delimited concatenation of the attribute values in sequential order

getKeyFields

public ElementDef[] getKeyFields()

Gets the metadata fields that make up the key of this object

Returns:

an array of metadata fields that make up the object's key

getName

public java.lang.String getName()

Gets the value of the <Name> element.

The SIF specification defines the meaning of this element as: "Name of learning resource component within the resource, i.e. "Chapter 1, Section 4."

Returns:

The Name element of this object.

Since:

2.0

setName

public void setName(java.lang.String value)

Sets the value of the <Name> element.

The SIF specification defines the meaning of this element as: "Name of learning resource component within the resource, i.e. "Chapter 1, Section 4."

Parameters:

value - A String object

Since:

2.0

getReference

public java.lang.String getReference()

Gets the value of the <Reference> element.

The SIF specification defines the meaning of this element as: "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."

Returns:

The Reference element of this object.

Since:

2.0

setReference

public void setReference(java.lang.String value)

Sets the value of the <Reference> element.

The SIF specification defines the meaning of this element as: "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."

Parameters:

value - A String object

Since:

2.0

getDescription

public java.lang.String getDescription()

Gets the value of the <Description> element.

The SIF specification defines the meaning of this element as: "Description of ResourceComponent, i.e. "Discover how changing the scale of a map can either increase or decrease the level of detail you see.""

Returns:

The Description element of this object.

Since:

2.0

setDescription

public void setDescription(java.lang.String value)

Sets the value of the <Description> element.

The SIF specification defines the meaning of this element as: "Description of ResourceComponent, i.e. "Discover how changing the scale of a map can either increase or decrease the level of detail you see.""

Parameters:

value - A String object

Since:

2.0

addStrategies

public void addStrategies(Strategies value)

Adds a new <Strategies> child element.

The SIF specification defines the meaning of this element as: "Teaching/learning strategies uses in the learning resource. One per element."

Parameters:

value - A Strategies object

Since:

2.0

getStrategieses

public Strategies[] getStrategieses()

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

Returns:

An array of Strategies objects

Since:

2.0

setStrategieses

public void setStrategieses(Strategies[] strategieses)

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

Since:

2.0

setAssociatedObjects

public void setAssociatedObjects(AssociatedObjects value)

Sets the value of the <AssociatedObjects> element.

Parameters:

value - A AssociatedObjects object

Since:

2.0

getAssociatedObjects

public AssociatedObjects getAssociatedObjects()

Gets the value of the <AssociatedObjects> element.

Returns:

An AssociatedObjects object

Since:

2.0

removeAssociatedObjects

public void removeAssociatedObjects()

Removes the AssociatedObjects child element previously created by calling setAssociatedObjects

Since:

2.0