com.edustructures.sifworks.instr
Class LearningStandardDocument

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class LearningStandardDocument
extends SIFDataObject

This object contains information related to curriculum standards documents and like documents. The LearningStandardDocument is an expectation of student work. 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

LearningStandardDocument()
Constructor

LearningStandardDocument(java.lang.String refId, LanguageCode language, java.lang.String title, Organization organizations, SubjectAreas subjectAreas, DocumentStatus documentStatus, java.lang.String learningStandardItemRefId)
Constructor that accepts values for all mandatory fields

Method Summary

Authors	getAuthors() Gets the value of the <Authors> element.
Copyright	getCopyright() Gets the value of the <Copyright> element.
java.lang.String	getDescription() Gets the value of the <Description> element.
java.util.Calendar	getDocumentDate() Gets the value of the <DocumentDate> element.
java.lang.String	getDocumentStatus() Gets the value of the <DocumentStatus> element.
java.util.Calendar	getEndOfLifeDate() Gets the value of the <EndOfLifeDate> element.
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	getLearningStandardItemRefId() Gets the value of the <LearningStandardItemRefId> element.
java.util.Calendar	getLocalAdoptionDate() Gets the value of the <LocalAdoptionDate> element.
java.util.Calendar	getLocalArchiveDate() Gets the value of the <LocalArchiveDate> element.
java.lang.String	getOrganizationContactPoint() Gets the value of the <OrganizationContactPoint> element.
Organizations	getOrganizations() Gets the value of the <Organizations> element.
java.lang.String	getRefId() Gets the value of the RefId attribute.
RelatedLearningStandards	getRelatedLearningStandards() Gets the value of the <RelatedLearningStandards> element.
java.util.Calendar	getRepositoryDate() Gets the value of the <RepositoryDate> element.
java.lang.String	getSource() Gets the value of the <Source> element.
SubjectAreas	getSubjectAreas() Gets the value of the <SubjectAreas> element.
java.lang.String	getTitle() Gets the value of the <Title> element.
void	removeAuthors() Removes the Authors child element previously created by calling setAuthors
void	removeCopyright() Removes the Copyright child element previously created by calling setCopyright
void	removeGradeLevels() Removes the GradeLevels child element previously created by calling setGradeLevels
void	removeOrganizations() Removes the Organizations child element previously created by calling setOrganizations
void	removeRelatedLearningStandards() Removes the RelatedLearningStandards child element previously created by calling setRelatedLearningStandards
void	removeSubjectAreas() Removes the SubjectAreas child element previously created by calling setSubjectAreas
void	setAuthors(Authors value) Sets the value of the <Authors> element.
void	setCopyright(Copyright value) Sets the value of the <Copyright> element.
void	setDescription(java.lang.String value) Sets the value of the <Description> element.
void	setDocumentDate(java.util.Calendar value) Sets the value of the <DocumentDate> element.
void	setDocumentStatus(DocumentStatus value) Sets the value of the <DocumentStatus> element.
void	setDocumentStatus(java.lang.String value) Sets the value of the <DocumentStatus> element as a String.
void	setEndOfLifeDate(java.util.Calendar value) Sets the value of the <EndOfLifeDate> element.
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	setLearningStandardItemRefId(java.lang.String value) Sets the value of the <LearningStandardItemRefId> element.
void	setLocalAdoptionDate(java.util.Calendar value) Sets the value of the <LocalAdoptionDate> element.
void	setLocalArchiveDate(java.util.Calendar value) Sets the value of the <LocalArchiveDate> element.
void	setOrganizationContactPoint(java.lang.String value) Sets the value of the <OrganizationContactPoint> element.
void	setOrganizations(Organization organization) Sets the value of the <Organizations> child element.
void	setOrganizations(Organizations value) Sets the value of the <Organizations> element.
void	setRefId(java.lang.String value) Sets the value of the RefId attribute.
void	setRelatedLearningStandards(RelatedLearningStandards value) Sets the value of the <RelatedLearningStandards> element.
void	setRepositoryDate(java.util.Calendar value) Sets the value of the <RepositoryDate> element.
void	setSource(LearningStandardDocumentSource value) Sets the value of the <Source> element.
void	setSource(java.lang.String value) Sets the value of the <Source> element as a String.
void	setSubjectAreas(SubjectAreas value) Sets the value of the <SubjectAreas> 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

LearningStandardDocument

public LearningStandardDocument()

Constructor

LearningStandardDocument

public LearningStandardDocument(java.lang.String refId,
                                LanguageCode language,
                                java.lang.String title,
                                Organization organizations,
                                SubjectAreas subjectAreas,
                                DocumentStatus documentStatus,
                                java.lang.String learningStandardItemRefId)

Constructor that accepts values for all mandatory fields

Parameters:

refId - ID for the standards document

language -

title - Name of standard document, i.e., "Washington Essential Academic Learning Requirements."

organizations - Name of organization represented by the document, i.e., "National Council of Teachers of Mathematics (NCTM)," "Washington," "Seattle School District."

subjectAreas - For a description of this element, see 5.1.30 SubjectArea.

documentStatus - ValuesDraft,AdoptedArchivedUnknown

learningStandardItemRefId - Link to the first/top LearningStandardItem in the Standard hierarchy

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: "ID for the standards document"

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: "ID for the standards document"

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

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 standard document, i.e., "Washington Essential Academic Learning Requirements.""

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 standard document, i.e., "Washington Essential Academic Learning Requirements.""

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 the standards document."

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 standards document."

Parameters:

value - A String object

Since:

1.5r1

getSource

public java.lang.String getSource()

Gets the value of the <Source> element.

The SIF specification defines the meaning of this element as: "Defines source of standard document. This is the descriptive type of the organization listed in Organization. It serves to describe the type of the standards contained within the document."

Returns:

The Source element of this object.

Since:

1.5r1

setSource

public void setSource(LearningStandardDocumentSource value)

Sets the value of the <Source> element.

The SIF specification defines the meaning of this element as: "Defines source of standard document. This is the descriptive type of the organization listed in Organization. It serves to describe the type of the standards contained within the document."

Parameters:

value - A constant defined by the LearningStandardDocumentSource class

Since:

1.5r1

setSource

public void setSource(java.lang.String value)

Sets the value of the <Source> element as a String.

The SIF specification defines the meaning of this element as: "Defines source of standard document. This is the descriptive type of the organization listed in Organization. It serves to describe the type of the standards contained within the document."

Parameters:

value - The value as a String

Since:

1.5r1

setOrganizations

public void setOrganizations(Organizations value)

Sets the value of the <Organizations> element.

The SIF specification defines the meaning of this element as: "Name of organization represented by the document, i.e., "National Council of Teachers of Mathematics (NCTM)," "Washington," "Seattle School District.""

Parameters:

value - A Organizations object

Since:

1.5r1

setOrganizations

public void setOrganizations(Organization organization)

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

Parameters:

organization - Name of organization represented by the document, i.e., "National Council of Teachers of Mathematics (NCTM)," "Washington," "Seattle School District."

Since:

1.5r1

getOrganizations

public Organizations getOrganizations()

Gets the value of the <Organizations> element.

The SIF specification defines the meaning of this element as: "Name of organization represented by the document, i.e., "National Council of Teachers of Mathematics (NCTM)," "Washington," "Seattle School District.""

Returns:

An Organizations object

Since:

1.5r1

removeOrganizations

public void removeOrganizations()

Removes the Organizations child element previously created by calling setOrganizations

Since:

1.5r1

setAuthors

public void setAuthors(Authors value)

Sets the value of the <Authors> element.

The SIF specification defines the meaning of this element as: "Name of the organization that authored the standards document, i.e. "Mid-Continent Research for Education & Learning (McREL)." May be the same as "Organization" above."

Parameters:

value - A Authors object

Since:

1.5r1

getAuthors

public Authors getAuthors()

Gets the value of the <Authors> element.

The SIF specification defines the meaning of this element as: "Name of the organization that authored the standards document, i.e. "Mid-Continent Research for Education & Learning (McREL)." May be the same as "Organization" above."

Returns:

An Authors object

Since:

1.5r1

removeAuthors

public void removeAuthors()

Removes the Authors child element previously created by calling setAuthors

Since:

1.5r1

getOrganizationContactPoint

public java.lang.String getOrganizationContactPoint()

Gets the value of the <OrganizationContactPoint> element.

The SIF specification defines the meaning of this element as: "A brief description of how to contact the organization maintaining the standards. It could be a phone number, email address, or URL."

Returns:

The OrganizationContactPoint element of this object.

Since:

1.5r1

setOrganizationContactPoint

public void setOrganizationContactPoint(java.lang.String value)

Sets the value of the <OrganizationContactPoint> element.

The SIF specification defines the meaning of this element as: "A brief description of how to contact the organization maintaining the standards. It could be a phone number, email address, or URL."

Parameters:

value - A String object

Since:

1.5r1

setSubjectAreas

public void setSubjectAreas(SubjectAreas value)

Sets the value of the <SubjectAreas> 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 SubjectAreas object

Since:

1.5r1

getSubjectAreas

public SubjectAreas getSubjectAreas()

Gets the value of the <SubjectAreas> element.

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

Returns:

A SubjectAreas object

Since:

1.5r1

removeSubjectAreas

public void removeSubjectAreas()

Removes the SubjectAreas child element previously created by calling setSubjectAreas

Since:

1.5r1

getDocumentStatus

public java.lang.String getDocumentStatus()

Gets the value of the <DocumentStatus> element.

The SIF specification defines the meaning of this element as: "ValuesDraft,AdoptedArchivedUnknown"

Returns:

The DocumentStatus element of this object.

Since:

1.5r1

setDocumentStatus

public void setDocumentStatus(DocumentStatus value)

Sets the value of the <DocumentStatus> element.

The SIF specification defines the meaning of this element as: "ValuesDraft,AdoptedArchivedUnknown"

Parameters:

value - A constant defined by the DocumentStatus class

Since:

1.5r1

setDocumentStatus

public void setDocumentStatus(java.lang.String value)

Sets the value of the <DocumentStatus> element as a String.

The SIF specification defines the meaning of this element as: "ValuesDraft,AdoptedArchivedUnknown"

Parameters:

value - The value as a String

Since:

1.5r1

getDocumentDate

public java.util.Calendar getDocumentDate()

Gets the value of the <DocumentDate> element.

The SIF specification defines the meaning of this element as: "The date the current status was achieved."

Returns:

The DocumentDate element of this object.

Since:

1.5r1

setDocumentDate

public void setDocumentDate(java.util.Calendar value)

Sets the value of the <DocumentDate> element.

The SIF specification defines the meaning of this element as: "The date the current status was achieved."

Parameters:

value - A Calendar object

Since:

1.5r1

getLocalAdoptionDate

public java.util.Calendar getLocalAdoptionDate()

Gets the value of the <LocalAdoptionDate> element.

The SIF specification defines the meaning of this element as: "The date the local organization adopted this standard document"

Returns:

The LocalAdoptionDate element of this object.

Since:

1.5r1

setLocalAdoptionDate

public void setLocalAdoptionDate(java.util.Calendar value)

Sets the value of the <LocalAdoptionDate> element.

The SIF specification defines the meaning of this element as: "The date the local organization adopted this standard document"

Parameters:

value - A Calendar object

Since:

1.5r1

getLocalArchiveDate

public java.util.Calendar getLocalArchiveDate()

Gets the value of the <LocalArchiveDate> element.

The SIF specification defines the meaning of this element as: "The date the local organization stopped using this standard document and superseded by a new document."

Returns:

The LocalArchiveDate element of this object.

Since:

1.5r1

setLocalArchiveDate

public void setLocalArchiveDate(java.util.Calendar value)

Sets the value of the <LocalArchiveDate> element.

The SIF specification defines the meaning of this element as: "The date the local organization stopped using this standard document and superseded by a new document."

Parameters:

value - A Calendar object

Since:

1.5r1

getEndOfLifeDate

public java.util.Calendar getEndOfLifeDate()

Gets the value of the <EndOfLifeDate> element.

The SIF specification defines the meaning of this element as: "This is the date that the governing organization retired this document. "

Returns:

The EndOfLifeDate element of this object.

Since:

1.5r1

setEndOfLifeDate

public void setEndOfLifeDate(java.util.Calendar value)

Sets the value of the <EndOfLifeDate> element.

The SIF specification defines the meaning of this element as: "This is the date that the governing organization retired this document. "

Parameters:

value - A Calendar object

Since:

1.5r1

setCopyright

public void setCopyright(Copyright value)

Sets the value of the <Copyright> element.

The SIF specification defines the meaning of this element as: "Copyright for document."

Parameters:

value - A Copyright object

Since:

1.5r1

getCopyright

public Copyright getCopyright()

Gets the value of the <Copyright> element.

The SIF specification defines the meaning of this element as: "Copyright for document."

Returns:

A Copyright object

Since:

1.5r1

removeCopyright

public void removeCopyright()

Removes the Copyright child element previously created by calling setCopyright

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: "SIF common GradeLevels element"

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: "SIF common GradeLevels element"

Returns:

A GradeLevels object

Since:

1.5r1

removeGradeLevels

public void removeGradeLevels()

Removes the GradeLevels child element previously created by calling setGradeLevels

Since:

1.5r1

getRepositoryDate

public java.util.Calendar getRepositoryDate()

Gets the value of the <RepositoryDate> element.

The SIF specification defines the meaning of this element as: "Date document data was added to the repository"

Returns:

The RepositoryDate element of this object.

Since:

1.5r1

setRepositoryDate

public void setRepositoryDate(java.util.Calendar value)

Sets the value of the <RepositoryDate> element.

The SIF specification defines the meaning of this element as: "Date document data was added to the repository"

Parameters:

value - A Calendar object

Since:

1.5r1

getLearningStandardItemRefId

public java.lang.String getLearningStandardItemRefId()

Gets the value of the <LearningStandardItemRefId> element.

The SIF specification defines the meaning of this element as: "Link to the first/top LearningStandardItem in the Standard hierarchy"

Returns:

The LearningStandardItemRefId element of this object.

Since:

1.5r1

setLearningStandardItemRefId

public void setLearningStandardItemRefId(java.lang.String value)

Sets the value of the <LearningStandardItemRefId> element.

The SIF specification defines the meaning of this element as: "Link to the first/top LearningStandardItem in the Standard hierarchy"

Parameters:

value - A String object

Since:

1.5r1

setRelatedLearningStandards

public void setRelatedLearningStandards(RelatedLearningStandards value)

Sets the value of the <RelatedLearningStandards> element.

The SIF specification defines the meaning of this element as: "Links to related LearningStandardDocument"

Parameters:

value - A RelatedLearningStandards object

Since:

1.5r1

getRelatedLearningStandards

public RelatedLearningStandards getRelatedLearningStandards()

Gets the value of the <RelatedLearningStandards> element.

The SIF specification defines the meaning of this element as: "Links to related LearningStandardDocument"

Returns:

A RelatedLearningStandards object

Since:

1.5r1

removeRelatedLearningStandards

public void removeRelatedLearningStandards()

Removes the RelatedLearningStandards child element previously created by calling setRelatedLearningStandards

Since:

1.5r1