com.edustructures.sifworks.instr
Class Lesson

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class Lesson
extends SIFDataObject

A series of Activities and LearningResources tied together under a particular topic or period of time to deliver a particular educational concept or skill. 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

Lesson()
Constructor

Lesson(java.lang.String refId, LanguageCode language, java.lang.String title)
Constructor that accepts values for all mandatory fields

Method Summary

CurriculumStructures	getCurriculumStructures() Gets the value of the <CurriculumStructures> element.
java.lang.String	getDescription() Gets the value of the <Description> element.
Duration	getDuration() Gets the value of the <Duration> 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.
LearningResources	getLearningResources() Gets the value of the <LearningResources> element.
LearningStandards	getLearningStandards() Gets the value of the <LearningStandards> element.
LessonSources	getLessonSources() Gets the value of the <LessonSources> element.
java.lang.String	getRefId() Gets the value of the RefId attribute.
Strategies	getStrategies() Gets the value of the <Strategies> element.
SubjectArea	getSubjectArea() Gets the value of the <SubjectArea> element.
SupportingActivities	getSupportingActivities() Gets the value of the <SupportingActivities> element.
java.lang.String	getTitle() Gets the value of the <Title> element.
void	removeCurriculumStructures() Removes the CurriculumStructures child element previously created by calling setCurriculumStructures
void	removeDuration() Removes the Duration child element previously created by calling setDuration
void	removeLearningObjectives() Removes the LearningObjectives child element previously created by calling setLearningObjectives
void	removeLearningResources() Removes the LearningResources child element previously created by calling setLearningResources
void	removeLearningStandards() Removes the LearningStandards child element previously created by calling setLearningStandards
void	removeLessonSources() Removes the LessonSources child element previously created by calling setLessonSources
void	removeStrategies() Removes the Strategies child element previously created by calling setStrategies
void	removeSubjectArea() Removes the SubjectArea child element previously created by calling setSubjectArea
void	removeSupportingActivities() Removes the SupportingActivities child element previously created by calling setSupportingActivities
void	setCurriculumStructures(CurriculumStructures value) Sets the value of the <CurriculumStructures> element.
void	setDescription(java.lang.String value) Sets the value of the <Description> element.
void	setDuration(Duration value) Sets the value of the <Duration> element.
void	setDuration(DurationUnits units, java.lang.String value) Sets the value of the <Duration> child 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	setLearningResources(LearningResources value) Sets the value of the <LearningResources> element.
void	setLearningStandards(LearningStandards value) Sets the value of the <LearningStandards> element.
void	setLessonSources(LessonSources value) Sets the value of the <LessonSources> 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.
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	setSupportingActivities(SupportingActivities value) Sets the value of the <SupportingActivities> element.
void	setTitle(java.lang.String value) Sets the value of the <Title> 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

Lesson

public Lesson()

Constructor

Lesson

public Lesson(java.lang.String refId,
              LanguageCode language,
              java.lang.String title)

Constructor that accepts values for all mandatory fields

Parameters:

refId -

language -

title - Name of lesson.

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.

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.

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

setCurriculumStructures

public void setCurriculumStructures(CurriculumStructures value)

Sets the value of the <CurriculumStructures> element.

The SIF specification defines the meaning of this element as: "A GUID reference to the parent CurriculumStructure object of this Lesson."

Parameters:

value - A CurriculumStructures object

Since:

1.5r1

getCurriculumStructures

public CurriculumStructures getCurriculumStructures()

Gets the value of the <CurriculumStructures> element.

The SIF specification defines the meaning of this element as: "A GUID reference to the parent CurriculumStructure object of this Lesson."

Returns:

A CurriculumStructures object

Since:

1.5r1

removeCurriculumStructures

public void removeCurriculumStructures()

Removes the CurriculumStructures child element previously created by calling setCurriculumStructures

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

getTitle

public java.lang.String getTitle()

Gets the value of the <Title> element.

The SIF specification defines the meaning of this element as: "Name of lesson."

Returns:

The Title element of this object.

Since:

1.5r1

setTitle

public void setTitle(java.lang.String value)

Sets the value of the <Title> element.

The SIF specification defines the meaning of this element as: "Name of lesson."

Parameters:

value - A String object

Since:

1.5r1

setDuration

public void setDuration(Duration value)

Sets the value of the <Duration> element.

The SIF specification defines the meaning of this element as: "Desired duration of the lesson"

Parameters:

value - A Duration object

Since:

1.5r1

setDuration

public void setDuration(DurationUnits units,
                        java.lang.String value)

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

Parameters:

units - Unit of time of the Duration value.

value - Gets or sets the content value of the <Duration> element

Since:

1.5r1

getDuration

public Duration getDuration()

Gets the value of the <Duration> element.

The SIF specification defines the meaning of this element as: "Desired duration of the lesson"

Returns:

A Duration object

Since:

1.5r1

removeDuration

public void removeDuration()

Removes the Duration child element previously created by calling setDuration

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 the lesson plan."

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 the lesson plan."

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 strategy used in this lesson plan."

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 strategy used in this lesson plan."

Returns:

A Strategies object

Since:

1.5r1

removeStrategies

public void removeStrategies()

Removes the Strategies child element previously created by calling setStrategies

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: "Description of learning objective(s) for this lesson, i.e., "Student will be able to use Pythagorean Theorem."--equates to 'benchmark' or 'goal' or other terminology"

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: "Description of learning objective(s) for this lesson, i.e., "Student will be able to use Pythagorean Theorem."--equates to 'benchmark' or 'goal' or other terminology"

Returns:

A LearningObjectives object

Since:

1.5r1

removeLearningObjectives

public void removeLearningObjectives()

Removes the LearningObjectives child element previously created by calling setLearningObjectives

Since:

1.5r1

setSupportingActivities

public void setSupportingActivities(SupportingActivities value)

Sets the value of the <SupportingActivities> element.

The SIF specification defines the meaning of this element as: "Links to Activity objects that make support the lesson"

Parameters:

value - A SupportingActivities object

Since:

1.5r1

getSupportingActivities

public SupportingActivities getSupportingActivities()

Gets the value of the <SupportingActivities> element.

The SIF specification defines the meaning of this element as: "Links to Activity objects that make support the lesson"

Returns:

A SupportingActivities object

Since:

1.5r1

removeSupportingActivities

public void removeSupportingActivities()

Removes the SupportingActivities child element previously created by calling setSupportingActivities

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: "Link to an associated LearningStandardItem. This allows for a single Lesson to be aligned to multiple standard statements."

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: "Link to an associated LearningStandardItem. This allows for a single Lesson to be aligned to multiple standard statements."

Returns:

A LearningStandards object

Since:

1.5r1

removeLearningStandards

public void removeLearningStandards()

Removes the LearningStandards child element previously created by calling setLearningStandards

Since:

1.5r1

setLearningResources

public void setLearningResources(LearningResources value)

Sets the value of the <LearningResources> element.

The SIF specification defines the meaning of this element as: "Link to an aligned LearningResource object."

Parameters:

value - A LearningResources object

Since:

1.5r1

getLearningResources

public LearningResources getLearningResources()

Gets the value of the <LearningResources> element.

The SIF specification defines the meaning of this element as: "Link to an aligned LearningResource object."

Returns:

A LearningResources object

Since:

1.5r1

removeLearningResources

public void removeLearningResources()

Removes the LearningResources child element previously created by calling setLearningResources

Since:

1.5r1

setLessonSources

public void setLessonSources(LessonSources value)

Sets the value of the <LessonSources> element.

The SIF specification defines the meaning of this element as: "One or more sources for the lesson. This describes the lesson's origin."

Parameters:

value - A LessonSources object

Since:

1.5r1

getLessonSources

public LessonSources getLessonSources()

Gets the value of the <LessonSources> element.

The SIF specification defines the meaning of this element as: "One or more sources for the lesson. This describes the lesson's origin."

Returns:

A LessonSources object

Since:

1.5r1

removeLessonSources

public void removeLessonSources()

Removes the LessonSources child element previously created by calling setLessonSources

Since:

1.5r1