com.edustructures.sifworks.instr
Class LearningStandardItem

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class LearningStandardItem
extends SIFDataObject

This object contains information related to curriculum standards statements "standards" or "benchmarks" or the like within the document. This object primarily focuses upon state department curriculum standards, published curriculum standards and local education agency learning standards. 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

LearningStandardItem()
Constructor

LearningStandardItem(java.lang.String refId, LanguageCode language, StandardHierarchyLevel standardHierarchyLevel, GradeLevels gradeLevels, java.lang.String learningStandardDocumentRefId)
Constructor that accepts values for all mandatory fields

Method Summary

GradeLevels	getGradeLevels() Gets the value of the <GradeLevels> 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.
java.lang.String	getLearningStandardDocumentRefId() Gets the value of the <LearningStandardDocumentRefId> element.
PredecessorItems	getPredecessorItems() Gets the value of the <PredecessorItems> element.
java.lang.String	getRefId() Gets the value of the RefId attribute.
StandardHierarchyLevel	getStandardHierarchyLevel() Gets the value of the <StandardHierarchyLevel> element.
StatementCodes	getStatementCodes() Gets the value of the <StatementCodes> element.
Statements	getStatements() Gets the value of the <Statements> element.
SubjectArea	getSubjectArea() Gets the value of the <SubjectArea> element.
void	removeGradeLevels() Removes the GradeLevels child element previously created by calling setGradeLevels
void	removePredecessorItems() Removes the PredecessorItems child element previously created by calling setPredecessorItems
void	removeStandardHierarchyLevel() Removes the StandardHierarchyLevel child element previously created by calling setStandardHierarchyLevel
void	removeStatementCodes() Removes the StatementCodes child element previously created by calling setStatementCodes
void	removeStatements() Removes the Statements child element previously created by calling setStatements
void	removeSubjectArea() Removes the SubjectArea child element previously created by calling setSubjectArea
void	setGradeLevels(GradeLevels value) Sets the value of the <GradeLevels> 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	setLearningStandardDocumentRefId(java.lang.String value) Sets the value of the <LearningStandardDocumentRefId> element.
void	setPredecessorItems(PredecessorItems value) Sets the value of the <PredecessorItems> element.
void	setRefId(java.lang.String value) Sets the value of the RefId attribute.
void	setStandardHierarchyLevel(StandardHierarchyLevel value) Sets the value of the <StandardHierarchyLevel> element.
void	setStandardHierarchyLevel(java.lang.String description, java.lang.Integer number) Sets the value of the <StandardHierarchyLevel> child element.
void	setStatementCodes(StatementCode statementCode) Sets the value of the <StatementCodes> child element.
void	setStatementCodes(StatementCodes value) Sets the value of the <StatementCodes> element.
void	setStatements(Statement statement) Sets the value of the <Statements> child element.
void	setStatements(Statements value) Sets the value of the <Statements> 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.

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

LearningStandardItem

public LearningStandardItem()

Constructor

LearningStandardItem

public LearningStandardItem(java.lang.String refId,
                            LanguageCode language,
                            StandardHierarchyLevel standardHierarchyLevel,
                            GradeLevels gradeLevels,
                            java.lang.String learningStandardDocumentRefId)

Constructor that accepts values for all mandatory fields

Parameters:

refId - GUID assigned to each statement at each level within the document hierarchy

language -

standardHierarchyLevel - Integer assigned to each hierarchical level within standards tree. The top level is "1".

gradeLevels - For a description of this element, see 5.1.12 GradeLevels.

learningStandardDocumentRefId - The RefId of the item's parent LearningStandardDocument.

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 assigned to each statement at each level within the document hierarchy"

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 assigned to each statement at each level within the document hierarchy"

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

setStandardHierarchyLevel

public void setStandardHierarchyLevel(StandardHierarchyLevel value)

Sets the value of the <StandardHierarchyLevel> element.

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

Parameters:

value - A StandardHierarchyLevel object

Since:

1.5r1

setStandardHierarchyLevel

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

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

Parameters:

description - Used to describe what role this item is serving in the structure. Some standards describe their levels in terms of standard, strands, and topics. Others use standards, benchmarks, and indicators. This attribute names the level of the item.

number - Integer assigned to each hierarchical level within standards tree. The top level is "1".

Since:

1.5r1

getStandardHierarchyLevel

public StandardHierarchyLevel getStandardHierarchyLevel()

Gets the value of the <StandardHierarchyLevel> element.

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

Returns:

A StandardHierarchyLevel object

Since:

1.5r1

removeStandardHierarchyLevel

public void removeStandardHierarchyLevel()

Removes the StandardHierarchyLevel child element previously created by calling setStandardHierarchyLevel

Since:

1.5r1

setPredecessorItems

public void setPredecessorItems(PredecessorItems value)

Sets the value of the <PredecessorItems> element.

The SIF specification defines the meaning of this element as: "GUID assigned to the LearningStandardItem directly above it in the hierarchy tree. This is a repeatable element because a single granular item may relate to multiple parent levels of the hierarchy."

Parameters:

value - A PredecessorItems object

Since:

1.5r1

getPredecessorItems

public PredecessorItems getPredecessorItems()

Gets the value of the <PredecessorItems> element.

The SIF specification defines the meaning of this element as: "GUID assigned to the LearningStandardItem directly above it in the hierarchy tree. This is a repeatable element because a single granular item may relate to multiple parent levels of the hierarchy."

Returns:

A PredecessorItems object

Since:

1.5r1

removePredecessorItems

public void removePredecessorItems()

Removes the PredecessorItems child element previously created by calling setPredecessorItems

Since:

1.5r1

setStatementCodes

public void setStatementCodes(StatementCodes value)

Sets the value of the <StatementCodes> element.

The SIF specification defines the meaning of this element as: "An alphanumeric ID code as defined by the organization to identify the statement."

Parameters:

value - A StatementCodes object

Since:

1.5r1

setStatementCodes

public void setStatementCodes(StatementCode statementCode)

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

Parameters:

statementCode - An alphanumeric ID code as defined by the organization to identify the statement.

Since:

1.5r1

getStatementCodes

public StatementCodes getStatementCodes()

Gets the value of the <StatementCodes> element.

The SIF specification defines the meaning of this element as: "An alphanumeric ID code as defined by the organization to identify the statement."

Returns:

A StatementCodes object

Since:

1.5r1

removeStatementCodes

public void removeStatementCodes()

Removes the StatementCodes child element previously created by calling setStatementCodes

Since:

1.5r1

setStatements

public void setStatements(Statements value)

Sets the value of the <Statements> element.

The SIF specification defines the meaning of this element as: "The text of the "standard," or "benchmark.""

Parameters:

value - A Statements object

Since:

1.5r1

setStatements

public void setStatements(Statement statement)

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

Parameters:

statement - The text of the "standard," or "benchmark."

Since:

1.5r1

getStatements

public Statements getStatements()

Gets the value of the <Statements> element.

The SIF specification defines the meaning of this element as: "The text of the "standard," or "benchmark.""

Returns:

A Statements object

Since:

1.5r1

removeStatements

public void removeStatements()

Removes the Statements child element previously created by calling setStatements

Since:

1.5r1

setGradeLevels

public void setGradeLevels(GradeLevels value)

Sets the value of the <GradeLevels> element.

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

Parameters:

value - A GradeLevels object

Since:

1.5r1

getGradeLevels

public GradeLevels getGradeLevels()

Gets the value of the <GradeLevels> element.

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

Returns:

A GradeLevels object

Since:

1.5r1

removeGradeLevels

public void removeGradeLevels()

Removes the GradeLevels child element previously created by calling setGradeLevels

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

getLearningStandardDocumentRefId

public java.lang.String getLearningStandardDocumentRefId()

Gets the value of the <LearningStandardDocumentRefId> element.

The SIF specification defines the meaning of this element as: "The RefId of the item's parent LearningStandardDocument."

Returns:

The LearningStandardDocumentRefId element of this object.

Since:

1.5r1

setLearningStandardDocumentRefId

public void setLearningStandardDocumentRefId(java.lang.String value)

Sets the value of the <LearningStandardDocumentRefId> element.

The SIF specification defines the meaning of this element as: "The RefId of the item's parent LearningStandardDocument."

Parameters:

value - A String object

Since:

1.5r1