com.edustructures.sifworks.instr
Class ResourceComponent

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.instr.ResourceComponent

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ResourceComponent
extends SIFKeyedElement

A lesson or activity-sized portion of a resource.

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

ResourceComponent()
Constructor

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

Method Summary

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.
java.lang.String	getRefId() Gets the value of the RefId attribute.
Strategies	getStrategies() Gets the value of the <Strategies> element.
void	removeAssociatedObjects() Removes the AssociatedObjects child element previously created by calling setAssociatedObjects
void	removeStrategies() Removes the Strategies child element previously created by calling setStrategies
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	setRefId(java.lang.String value) Sets the value of the RefId attribute.
void	setStrategies(Strategies value) Sets the value of the <Strategies> element.

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

ResourceComponent

public ResourceComponent()

Constructor

ResourceComponent

public ResourceComponent(java.lang.String refId,
                         java.lang.String name,
                         java.lang.String reference)

Constructor that accepts values for all mandatory fields

Parameters:

refId - GUID for resource component

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

getRefId

public java.lang.String getRefId()

Gets the value of the RefId attribute.

The SIF specification defines the meaning of this attribute as: "GUID for resource component"

Returns:

The RefId attribute of this object.

Since:

1.5r1

setRefId

public void setRefId(java.lang.String value)

Sets the value of the RefId attribute.

The SIF specification defines the meaning of this attribute as: "GUID for resource component"

Parameters:

value - A String object

Since:

1.5r1

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:

1.5r1

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:

1.5r1

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:

1.5r1

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:

1.5r1

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:

1.5r1

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:

1.5r1

setStrategies

public void setStrategies(Strategies value)

Sets the value of the <Strategies> 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:

1.5r1

getStrategies

public Strategies getStrategies()

Gets the value of the <Strategies> element.

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

Returns:

A Strategies object

Since:

1.5r1

removeStrategies

public void removeStrategies()

Removes the Strategies child element previously created by calling setStrategies

Since:

1.5r1

setAssociatedObjects

public void setAssociatedObjects(AssociatedObjects value)

Sets the value of the <AssociatedObjects> element.

The SIF specification defines the meaning of this element as: "Reference from ResourceComponent to associated elements within another SIF object."

Parameters:

value - A AssociatedObjects object

Since:

1.5r1

getAssociatedObjects

public AssociatedObjects getAssociatedObjects()

Gets the value of the <AssociatedObjects> element.

The SIF specification defines the meaning of this element as: "Reference from ResourceComponent to associated elements within another SIF object."

Returns:

An AssociatedObjects object

Since:

1.5r1

removeAssociatedObjects

public void removeAssociatedObjects()

Removes the AssociatedObjects child element previously created by calling setAssociatedObjects

Since:

1.5r1