com.edustructures.sifworks.student
Class SchoolCourseInfo

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFDataObject
              com.edustructures.sifworks.student.SchoolCourseInfo

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SchoolCourseInfo
extends SIFDataObject

This object is for course information. SIF_Events are reported.

Since:

1.1

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

SchoolCourseInfo()
Constructor

SchoolCourseInfo(java.lang.String refId, java.lang.String schoolInfoRefId, java.lang.Integer schoolYear, java.lang.String courseCode, java.lang.String courseTitle)
Constructor that accepts values for all mandatory fields

Method Summary

java.lang.String	getCoreAcademicCourse() Gets the value of the <CoreAcademicCourse> element.
java.lang.String	getCourseCode() Gets the value of the <CourseCode> element.
CourseCredits	getCourseCredits() Gets the value of the <CourseCredits> element.
java.lang.String	getCourseTitle() Gets the value of the <CourseTitle> element.
java.lang.String	getDepartment() Gets the value of the <Department> element.
java.lang.String	getDescription() Gets the value of the <Description> element.
java.lang.String	getDistrictCourseCode() Gets the value of the <DistrictCourseCode> element.
java.lang.String	getGraduationRequirement() Gets the value of the <GraduationRequirement> element.
InstructionalLevel	getInstructionalLevel() Gets the value of the <InstructionalLevel> 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	getRefId() Gets the value of the RefId attribute.
SCEDCode	getSCEDCode() Gets the value of the <SCEDCode> element.
java.lang.String	getSchoolInfoRefId() Gets the value of the SchoolInfoRefId attribute.
java.lang.Integer	getSchoolYear() Gets the value of the SchoolYear attribute.
java.lang.String	getStateCourseCode() Gets the value of the <StateCourseCode> element.
SubjectAreaList	getSubjectAreaList() Gets the value of the <SubjectAreaList> element.
void	removeCourseCredits() Removes the CourseCredits child element previously created by calling setCourseCredits
void	removeInstructionalLevel() Removes the InstructionalLevel child element previously created by calling setInstructionalLevel
void	removeSCEDCode() Removes the SCEDCode child element previously created by calling setSCEDCode
void	removeSubjectAreaList() Removes the SubjectAreaList child element previously created by calling setSubjectAreaList
void	setCoreAcademicCourse(java.lang.String value) Sets the value of the <CoreAcademicCourse> element as a String.
void	setCoreAcademicCourse(YesNo value) Sets the value of the <CoreAcademicCourse> element.
void	setCourseCode(java.lang.String value) Sets the value of the <CourseCode> element.
void	setCourseCredits(CourseCredits value) Sets the value of the <CourseCredits> element.
void	setCourseCredits(CreditType type, java.math.BigDecimal value) Sets the value of the <CourseCredits> child element.
void	setCourseTitle(java.lang.String value) Sets the value of the <CourseTitle> element.
void	setDepartment(java.lang.String value) Sets the value of the <Department> element.
void	setDescription(java.lang.String value) Sets the value of the <Description> element.
void	setDistrictCourseCode(java.lang.String value) Sets the value of the <DistrictCourseCode> element.
void	setGraduationRequirement(java.lang.String value) Sets the value of the <GraduationRequirement> element as a String.
void	setGraduationRequirement(YesNo value) Sets the value of the <GraduationRequirement> element.
void	setInstructionalLevel(InstructionalLevel value) Sets the value of the <InstructionalLevel> element.
void	setRefId(java.lang.String value) Sets the value of the RefId attribute.
void	setSCEDCode(SCEDCode value) Sets the value of the <SCEDCode> element.
void	setSchoolInfoRefId(java.lang.String value) Sets the value of the SchoolInfoRefId attribute.
void	setSchoolYear(java.lang.Integer value) Sets the value of the SchoolYear attribute.
void	setStateCourseCode(java.lang.String value) Sets the value of the <StateCourseCode> element.
void	setSubjectAreaList(SubjectAreaList value) Sets the value of the <SubjectAreaList> 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

SchoolCourseInfo

public SchoolCourseInfo()

Constructor

SchoolCourseInfo

public SchoolCourseInfo(java.lang.String refId,
                        java.lang.String schoolInfoRefId,
                        java.lang.Integer schoolYear,
                        java.lang.String courseCode,
                        java.lang.String courseTitle)

Constructor that accepts values for all mandatory fields

Parameters:

refId - The ID (GUID) that uniquely identifies the school course.

schoolInfoRefId - The ID (GUID) that identifies the school where the course is offered.

schoolYear - School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g. 2007 for the 2006-07 school year).

courseCode - School-defined local code for the course.

courseTitle - Title of the course.

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: "The ID (GUID) that uniquely identifies the school course."

Overrides:

getRefId in class SIFDataObject

Returns:

The RefId attribute of this object.

Since:

1.1

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: "The ID (GUID) that uniquely identifies the school course."

Parameters:

value - A String object

Since:

1.1

getSchoolInfoRefId

public java.lang.String getSchoolInfoRefId()

Gets the value of the SchoolInfoRefId attribute.

The SIF specification defines the meaning of this attribute as: "The ID (GUID) that identifies the school where the course is offered."

Returns:

The SchoolInfoRefId attribute of this object.

Since:

1.1

setSchoolInfoRefId

public void setSchoolInfoRefId(java.lang.String value)

Sets the value of the SchoolInfoRefId attribute.

The SIF specification defines the meaning of this attribute as: "The ID (GUID) that identifies the school where the course is offered."

Parameters:

value - A String object

Since:

1.1

getSchoolYear

public java.lang.Integer getSchoolYear()

Gets the value of the SchoolYear attribute.

The SIF specification defines the meaning of this attribute as: "School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g. 2007 for the 2006-07 school year)."

Returns:

The SchoolYear attribute of this object.

Since:

2.0

setSchoolYear

public void setSchoolYear(java.lang.Integer value)

Sets the value of the SchoolYear attribute.

The SIF specification defines the meaning of this attribute as: "School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g. 2007 for the 2006-07 school year)."

Parameters:

value - A Integer object

Since:

2.0

getCourseCode

public java.lang.String getCourseCode()

Gets the value of the <CourseCode> element.

The SIF specification defines the meaning of this element as: "School-defined local code for the course."

Returns:

The CourseCode element of this object.

Since:

1.1

setCourseCode

public void setCourseCode(java.lang.String value)

Sets the value of the <CourseCode> element.

The SIF specification defines the meaning of this element as: "School-defined local code for the course."

Parameters:

value - A String object

Since:

1.1

getStateCourseCode

public java.lang.String getStateCourseCode()

Gets the value of the <StateCourseCode> element.

The SIF specification defines the meaning of this element as: "State-defined standard course code used to report information about courses."

Returns:

The StateCourseCode element of this object.

Since:

1.1

setStateCourseCode

public void setStateCourseCode(java.lang.String value)

Sets the value of the <StateCourseCode> element.

The SIF specification defines the meaning of this element as: "State-defined standard course code used to report information about courses."

Parameters:

value - A String object

Since:

1.1

getDistrictCourseCode

public java.lang.String getDistrictCourseCode()

Gets the value of the <DistrictCourseCode> element.

The SIF specification defines the meaning of this element as: "The corresponding district course code."

Returns:

The DistrictCourseCode element of this object.

Since:

1.1

setDistrictCourseCode

public void setDistrictCourseCode(java.lang.String value)

Sets the value of the <DistrictCourseCode> element.

The SIF specification defines the meaning of this element as: "The corresponding district course code."

Parameters:

value - A String object

Since:

1.1

setSubjectAreaList

public void setSubjectAreaList(SubjectAreaList value)

Sets the value of the <SubjectAreaList> element.

The SIF specification defines the meaning of this element as: "Subject matter area or department"

Parameters:

value - A SubjectAreaList object

Since:

1.1

getSubjectAreaList

public SubjectAreaList getSubjectAreaList()

Gets the value of the <SubjectAreaList> element.

The SIF specification defines the meaning of this element as: "Subject matter area or department"

Returns:

A SubjectAreaList object

Since:

1.1

removeSubjectAreaList

public void removeSubjectAreaList()

Removes the SubjectAreaList child element previously created by calling setSubjectAreaList

Since:

1.1

getCourseTitle

public java.lang.String getCourseTitle()

Gets the value of the <CourseTitle> element.

The SIF specification defines the meaning of this element as: "Title of the course."

Returns:

The CourseTitle element of this object.

Since:

1.1

setCourseTitle

public void setCourseTitle(java.lang.String value)

Sets the value of the <CourseTitle> element.

The SIF specification defines the meaning of this element as: "Title of the course."

Parameters:

value - A String object

Since:

1.1

getDescription

public java.lang.String getDescription()

Gets the value of the <Description> element.

The SIF specification defines the meaning of this element as: "Textual description of the course."

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: "Textual description of the course."

Parameters:

value - A String object

Since:

1.5r1

setInstructionalLevel

public void setInstructionalLevel(InstructionalLevel value)

Sets the value of the <InstructionalLevel> element.

The SIF specification defines the meaning of this element as: "An indication of the general nature and difficulty of instruction provided."

Parameters:

value - A InstructionalLevel object

Since:

1.1

getInstructionalLevel

public InstructionalLevel getInstructionalLevel()

Gets the value of the <InstructionalLevel> element.

The SIF specification defines the meaning of this element as: "An indication of the general nature and difficulty of instruction provided."

Returns:

An InstructionalLevel object

Since:

1.1

removeInstructionalLevel

public void removeInstructionalLevel()

Removes the InstructionalLevel child element previously created by calling setInstructionalLevel

Since:

1.1

setCourseCredits

public void setCourseCredits(CourseCredits value)

Sets the value of the <CourseCredits> element.

The SIF specification defines the meaning of this element as: "The number of credits awarded upon course completion."

Parameters:

value - A CourseCredits object

Since:

1.1

setCourseCredits

public void setCourseCredits(CreditType type,
                             java.math.BigDecimal value)

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

Parameters:

type - The type of credit offered

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

Since:

1.1

getCourseCredits

public CourseCredits getCourseCredits()

Gets the value of the <CourseCredits> element.

The SIF specification defines the meaning of this element as: "The number of credits awarded upon course completion."

Returns:

A CourseCredits object

Since:

1.1

removeCourseCredits

public void removeCourseCredits()

Removes the CourseCredits child element previously created by calling setCourseCredits

Since:

1.1

getCoreAcademicCourse

public java.lang.String getCoreAcademicCourse()

Gets the value of the <CoreAcademicCourse> element.

The SIF specification defines the meaning of this element as: "Does the course meet the state definition of a core academic course?"

Returns:

The CoreAcademicCourse element of this object.

Since:

1.5r1

setCoreAcademicCourse

public void setCoreAcademicCourse(YesNo value)

Sets the value of the <CoreAcademicCourse> element.

The SIF specification defines the meaning of this element as: "Does the course meet the state definition of a core academic course?"

Parameters:

value - A constant defined by the YesNo class

Since:

1.5r1

setCoreAcademicCourse

public void setCoreAcademicCourse(java.lang.String value)

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

The SIF specification defines the meaning of this element as: "Does the course meet the state definition of a core academic course?"

Parameters:

value - The value as a String

Since:

1.5r1

getGraduationRequirement

public java.lang.String getGraduationRequirement()

Gets the value of the <GraduationRequirement> element.

The SIF specification defines the meaning of this element as: "Does the state require that the course be completed for graduation?"

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.5r1	"GradRequirement"
SIF2.0	"GraduationRequirement"

Returns:

The GraduationRequirement element of this object.

Since:

1.5r1

setGraduationRequirement

public void setGraduationRequirement(YesNo value)

Sets the value of the <GraduationRequirement> element.

The SIF specification defines the meaning of this element as: "Does the state require that the course be completed for graduation?"

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.5r1	"GradRequirement"
SIF2.0	"GraduationRequirement"

Parameters:

value - A constant defined by the YesNo class

Since:

1.5r1

setGraduationRequirement

public void setGraduationRequirement(java.lang.String value)

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

The SIF specification defines the meaning of this element as: "Does the state require that the course be completed for graduation?"

This element is known by more than one tag name depending on the version of SIF in use. The ADK will use the tag names shown below when parsing and rendering elements of this kind.

Version	Tag
1.5r1	"GradRequirement"
SIF2.0	"GraduationRequirement"

Parameters:

value - The value as a String

Since:

1.5r1

getDepartment

public java.lang.String getDepartment()

Gets the value of the <Department> element.

Returns:

The Department element of this object.

Since:

2.0

setDepartment

public void setDepartment(java.lang.String value)

Sets the value of the <Department> element.

Parameters:

value - A String object

Since:

2.0

setSCEDCode

public void setSCEDCode(SCEDCode value)

Sets the value of the <SCEDCode> element.

The SIF specification defines the meaning of this element as: "Course code from the School Codes for the Exchange of Data that describes the course content."

Parameters:

value - A SCEDCode object

Since:

2.0

getSCEDCode

public SCEDCode getSCEDCode()

Gets the value of the <SCEDCode> element.

The SIF specification defines the meaning of this element as: "Course code from the School Codes for the Exchange of Data that describes the course content."

Returns:

A SCEDCode object

Since:

2.0

removeSCEDCode

public void removeSCEDCode()

Removes the SCEDCode child element previously created by calling setSCEDCode

Since:

2.0