com.edustructures.sifworks.instr
Class CurriculumStructure

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFDataObject
              com.edustructures.sifworks.instr.CurriculumStructure

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class CurriculumStructure
extends SIFDataObject

An object designed to contain instructional objects such as units, lessons, activities, and assessments joined together under a particular topic and/or duration. SIF_Events are reported.

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

CurriculumStructure()
Constructor

CurriculumStructure(java.lang.String refId, LanguageCode language, Title titles, CurriculumHierarchyLevel curriculumHierarchyLevel)
Constructor that accepts values for all mandatory fields

Method Summary

ComponentObjects	getComponentObjects() Gets the value of the <ComponentObjects> element.
CurriculumHierarchyLevel	getCurriculumHierarchyLevel() Gets the value of the <CurriculumHierarchyLevel> 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	getLanguage() Gets the value of the Language attribute.
LearningObjectives	getLearningObjectives() Gets the value of the <LearningObjectives> element.
LearningStandards	getLearningStandards() Gets the value of the <LearningStandards> element.
PredecessorObjects	getPredecessorObjects() Gets the value of the <PredecessorObjects> element.
java.lang.String	getRefId() Gets the value of the RefId attribute.
SubjectArea	getSubjectArea() Gets the value of the <SubjectArea> element.
Titles	getTitles() Gets the value of the <Titles> element.
void	removeComponentObjects() Removes the ComponentObjects child element previously created by calling setComponentObjects
void	removeCurriculumHierarchyLevel() Removes the CurriculumHierarchyLevel child element previously created by calling setCurriculumHierarchyLevel
void	removeLearningObjectives() Removes the LearningObjectives child element previously created by calling setLearningObjectives
void	removeLearningStandards() Removes the LearningStandards child element previously created by calling setLearningStandards
void	removePredecessorObjects() Removes the PredecessorObjects child element previously created by calling setPredecessorObjects
void	removeSubjectArea() Removes the SubjectArea child element previously created by calling setSubjectArea
void	removeTitles() Removes the Titles child element previously created by calling setTitles
void	setComponentObjects(ComponentObjects value) Sets the value of the <ComponentObjects> element.
void	setCurriculumHierarchyLevel(CurriculumHierarchyLevel value) Sets the value of the <CurriculumHierarchyLevel> element.
void	setCurriculumHierarchyLevel(java.lang.String name, java.lang.Integer number, java.lang.String description) Sets the value of the <CurriculumHierarchyLevel> child element.
void	setDescription(java.lang.String value) Sets the value of the <Description> element.
void	setLanguage(LanguageCode value) Sets the value of the Language attribute.
void	setLanguage(java.lang.String value) Sets the value of the Language attribute as a String.
void	setLearningObjectives(LearningObjectives value) Sets the value of the <LearningObjectives> element.
void	setLearningStandards(LearningStandards value) Sets the value of the <LearningStandards> element.
void	setPredecessorObjects(PredecessorObjects value) Sets the value of the <PredecessorObjects> element.
void	setRefId(java.lang.String value) Sets the value of the RefId attribute.
void	setSubjectArea(java.lang.String code) Sets the value of the <SubjectArea> child element.
void	setSubjectArea(SubjectArea value) Sets the value of the <SubjectArea> element.
void	setTitles(Title title) Sets the value of the <Titles> child element.
void	setTitles(Titles value) Sets the value of the <Titles> element.

Methods inherited from class com.edustructures.sifworks.SIFDataObject

addSIFExtendedElement, clone, getElementOrAttribute, getObjectTag, getObjectType, getSIFExtendedElement, getSIFExtendedElements, getSIFExtendedElementsContainer, getSIFMetadata, getSIFVersion, setElementOrAttribute, setElementOrAttribute, setElementOrAttribute, setSIFExtendedElements, setSIFExtendedElementsContainer, setSIFMetadata, setSIFVersion, toXML

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getSIFValue, getTextValue, getXmlId, hasTextValue, removeChild, removeChild, removeChild, removeChild, restoreImplementationDef, setChanged, setChildren, setEmpty, setField, setField, setField, setField, setSIFValue, 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

CurriculumStructure

public CurriculumStructure()

Constructor

CurriculumStructure

public CurriculumStructure(java.lang.String refId,
                           LanguageCode language,
                           Title titles,
                           CurriculumHierarchyLevel curriculumHierarchyLevel)

Constructor that accepts values for all mandatory fields

Parameters:

refId - GUID for this particular object.

language -

titles - Name of this type of curriculum object (e.g., "American Revolutionary War")

curriculumHierarchyLevel - Integer assigned to each hierarchical level within the CurriculumStructure tree. The top level is "1".

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 this particular object."

Overrides:

getRefId in class SIFDataObject

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 this particular object."

Parameters:

value - A String object

Since:

1.5r1

getLanguage

public java.lang.String getLanguage()

Gets the value of the Language attribute.

Returns:

The Language attribute of this object.

Since:

1.5r1

setLanguage

public void setLanguage(LanguageCode value)

Sets the value of the Language attribute.

Parameters:

value - A constant defined by the LanguageCode class

Since:

1.5r1

setLanguage

public void setLanguage(java.lang.String value)

Sets the value of the Language attribute as a String.

Parameters:

value - The value as a String

Since:

1.5r1

setTitles

public void setTitles(Titles value)

Sets the value of the <Titles> element.

The SIF specification defines the meaning of this element as: "Name of this type of curriculum object (e.g., "American Revolutionary War")"

Parameters:

value - A Titles object

Since:

1.5r1

setTitles

public void setTitles(Title title)

Sets the value of the <Titles> child element. This form of setTitles is provided as a convenience method that is functionally equivalent to the version of setTitles that accepts a single Titles object.

Parameters:

title - Name of this type of curriculum object (e.g., "American Revolutionary War")

Since:

1.5r1

getTitles

public Titles getTitles()

Gets the value of the <Titles> element.

The SIF specification defines the meaning of this element as: "Name of this type of curriculum object (e.g., "American Revolutionary War")"

Returns:

A Titles object

Since:

1.5r1

removeTitles

public void removeTitles()

Removes the Titles child element previously created by calling setTitles

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 this curriculum object"

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 this curriculum object"

Parameters:

value - A String object

Since:

1.5r1

setSubjectArea

public void setSubjectArea(SubjectArea value)

Sets the value of the <SubjectArea> element.

The SIF specification defines the meaning of this element as: "For a description of this element, see 5.1.30 SubjectArea."

Parameters:

value - A SubjectArea object

Since:

1.5r1

setSubjectArea

public void setSubjectArea(java.lang.String code)

Sets the value of the <SubjectArea> child element. This form of setSubjectArea is provided as a convenience method that is functionally equivalent to the version of setSubjectArea that accepts a single SubjectArea object.

Parameters:

code - The subject area code (i.e. the first two digits of the course classification code)

Since:

1.5r1

getSubjectArea

public SubjectArea getSubjectArea()

Gets the value of the <SubjectArea> element.

The SIF specification defines the meaning of this element as: "For a description of this element, see 5.1.30 SubjectArea."

Returns:

A SubjectArea object

Since:

1.5r1

removeSubjectArea

public void removeSubjectArea()

Removes the SubjectArea child element previously created by calling setSubjectArea

Since:

1.5r1

setCurriculumHierarchyLevel

public void setCurriculumHierarchyLevel(CurriculumHierarchyLevel value)

Sets the value of the <CurriculumHierarchyLevel> element.

The SIF specification defines the meaning of this element as: "Integer assigned to each hierarchical level within the CurriculumStructure tree. The top level is "1"."

Parameters:

value - A CurriculumHierarchyLevel object

Since:

1.5r1

setCurriculumHierarchyLevel

public void setCurriculumHierarchyLevel(java.lang.String name,
                                        java.lang.Integer number,
                                        java.lang.String description)

Sets the value of the <CurriculumHierarchyLevel> child element. This form of setCurriculumHierarchyLevel is provided as a convenience method that is functionally equivalent to the version of setCurriculumHierarchyLevel that accepts a single CurriculumHierarchyLevel object.

Parameters:

name - Used to describe what role this is serving in the structure. Some curriculum objects describe their levels in terms of programs of study, courses and units. Others use other terms. This attribute names the level of the item.

number - Integer assigned to each hierarchical level within the CurriculumStructure tree. The top level is 1.

description - Used to describe what role this is serving in the structure. Some curriculum objects describe their levels in terms of programs of study, courses and units. Others use other terms.

Since:

1.5r1

getCurriculumHierarchyLevel

public CurriculumHierarchyLevel getCurriculumHierarchyLevel()

Gets the value of the <CurriculumHierarchyLevel> element.

The SIF specification defines the meaning of this element as: "Integer assigned to each hierarchical level within the CurriculumStructure tree. The top level is "1"."

Returns:

A CurriculumHierarchyLevel object

Since:

1.5r1

removeCurriculumHierarchyLevel

public void removeCurriculumHierarchyLevel()

Removes the CurriculumHierarchyLevel child element previously created by calling setCurriculumHierarchyLevel

Since:

1.5r1

setPredecessorObjects

public void setPredecessorObjects(PredecessorObjects value)

Sets the value of the <PredecessorObjects> element.

The SIF specification defines the meaning of this element as: "GUID assigned to the CurriculumStructure object directly above it in the hierarchy tree. This is repeatable because a single object can have multiple parent levels of the hierarchy. It is null if there is no parent object."

Parameters:

value - A PredecessorObjects object

Since:

1.5r1

getPredecessorObjects

public PredecessorObjects getPredecessorObjects()

Gets the value of the <PredecessorObjects> element.

The SIF specification defines the meaning of this element as: "GUID assigned to the CurriculumStructure object directly above it in the hierarchy tree. This is repeatable because a single object can have multiple parent levels of the hierarchy. It is null if there is no parent object."

Returns:

A PredecessorObjects object

Since:

1.5r1

removePredecessorObjects

public void removePredecessorObjects()

Removes the PredecessorObjects child element previously created by calling setPredecessorObjects

Since:

1.5r1

setLearningObjectives

public void setLearningObjectives(LearningObjectives value)

Sets the value of the <LearningObjectives> element.

The SIF specification defines the meaning of this element as: "Narrative description of learning objective(s) for the CurriculumStructure object. "

Parameters:

value - A LearningObjectives object

Since:

1.5r1

getLearningObjectives

public LearningObjectives getLearningObjectives()

Gets the value of the <LearningObjectives> element.

The SIF specification defines the meaning of this element as: "Narrative description of learning objective(s) for the CurriculumStructure object. "

Returns:

A LearningObjectives object

Since:

1.5r1

removeLearningObjectives

public void removeLearningObjectives()

Removes the LearningObjectives child element previously created by calling setLearningObjectives

Since:

1.5r1

setComponentObjects

public void setComponentObjects(ComponentObjects value)

Sets the value of the <ComponentObjects> element.

The SIF specification defines the meaning of this element as: "A GUID reference to the component objects, if any, that make up this object."

Parameters:

value - A ComponentObjects object

Since:

1.5r1

getComponentObjects

public ComponentObjects getComponentObjects()

Gets the value of the <ComponentObjects> element.

The SIF specification defines the meaning of this element as: "A GUID reference to the component objects, if any, that make up this object."

Returns:

A ComponentObjects object

Since:

1.5r1

removeComponentObjects

public void removeComponentObjects()

Removes the ComponentObjects child element previously created by calling setComponentObjects

Since:

1.5r1

setLearningStandards

public void setLearningStandards(LearningStandards value)

Sets the value of the <LearningStandards> element.

The SIF specification defines the meaning of this element as: "Associated learning standards."

Parameters:

value - A LearningStandards object

Since:

1.5r1

getLearningStandards

public LearningStandards getLearningStandards()

Gets the value of the <LearningStandards> element.

The SIF specification defines the meaning of this element as: "Associated learning standards."

Returns:

A LearningStandards object

Since:

1.5r1

removeLearningStandards

public void removeLearningStandards()

Removes the LearningStandards child element previously created by calling setLearningStandards

Since:

1.5r1