com.edustructures.sifworks.etranscripts
Class Course

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.etranscripts.Course

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class Course
extends SIFKeyedElement

Since:

2.0

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

Course()
Constructor

Course(MarkingPeriod markingPeriods)
Constructor that accepts values for all mandatory fields

Method Summary

PartialDateType	getEndDate() Gets the value of the <EndDate> 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
MarkingPeriods	getMarkingPeriods() Gets the value of the <MarkingPeriods> element.
java.lang.String	getSchoolAttendedRefId() Gets the value of the <SchoolAttendedRefId> element.
SchoolCourseInfoData	getSchoolCourseInfoData() Gets the value of the <SchoolCourseInfoData> element.
PartialDateType	getStartDate() Gets the value of the <StartDate> element.
void	removeEndDate() Removes the EndDate child element previously created by calling setEndDate
void	removeMarkingPeriods() Removes the MarkingPeriods child element previously created by calling setMarkingPeriods
void	removeSchoolCourseInfoData() Removes the SchoolCourseInfoData child element previously created by calling setSchoolCourseInfoData
void	removeStartDate() Removes the StartDate child element previously created by calling setStartDate
void	setEndDate(PartialDateType value) Sets the value of the <EndDate> element.
void	setEndDate(java.lang.String value) Sets the value of the <EndDate> child element.
void	setMarkingPeriods(MarkingPeriod markingPeriod) Sets the value of the <MarkingPeriods> child element.
void	setMarkingPeriods(MarkingPeriods value) Sets the value of the <MarkingPeriods> element.
void	setSchoolAttendedRefId(java.lang.String value) Sets the value of the <SchoolAttendedRefId> element.
void	setSchoolCourseInfoData(SchoolCourseInfoData value) Sets the value of the <SchoolCourseInfoData> element.
void	setStartDate(PartialDateType value) Sets the value of the <StartDate> element.
void	setStartDate(java.lang.String value) Sets the value of the <StartDate> child element.

Methods inherited from class com.edustructures.sifworks.SIFElement

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

Course

public Course()

Constructor

Course

public Course(MarkingPeriod markingPeriods)

Constructor that accepts values for all mandatory fields

Parameters:

markingPeriods -

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

getSchoolAttendedRefId

public java.lang.String getSchoolAttendedRefId()

Gets the value of the <SchoolAttendedRefId> element.

The SIF specification defines the meaning of this element as: "Reference to the school where the course is being taken (see SchoolAttended); may be omitted if the school is the same as the school of record."

Returns:

The SchoolAttendedRefId element of this object.

Since:

2.0

setSchoolAttendedRefId

public void setSchoolAttendedRefId(java.lang.String value)

Sets the value of the <SchoolAttendedRefId> element.

The SIF specification defines the meaning of this element as: "Reference to the school where the course is being taken (see SchoolAttended); may be omitted if the school is the same as the school of record."

Parameters:

value - A String object

Since:

2.0

setSchoolCourseInfoData

public void setSchoolCourseInfoData(SchoolCourseInfoData value)

Sets the value of the <SchoolCourseInfoData> element.

Parameters:

value - A SchoolCourseInfoData object

Since:

2.0

getSchoolCourseInfoData

public SchoolCourseInfoData getSchoolCourseInfoData()

Gets the value of the <SchoolCourseInfoData> element.

Returns:

A SchoolCourseInfoData object

Since:

2.0

removeSchoolCourseInfoData

public void removeSchoolCourseInfoData()

Removes the SchoolCourseInfoData child element previously created by calling setSchoolCourseInfoData

Since:

2.0

setStartDate

public void setStartDate(PartialDateType value)

Sets the value of the <StartDate> element.

The SIF specification defines the meaning of this element as: "Date course section started."

Parameters:

value - A PartialDateType object

Since:

2.0

setStartDate

public void setStartDate(java.lang.String value)

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

Parameters:

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

Since:

2.0

getStartDate

public PartialDateType getStartDate()

Gets the value of the <StartDate> element.

The SIF specification defines the meaning of this element as: "Date course section started."

Returns:

A PartialDateType object

Since:

2.0

removeStartDate

public void removeStartDate()

Removes the StartDate child element previously created by calling setStartDate

Since:

2.0

setEndDate

public void setEndDate(PartialDateType value)

Sets the value of the <EndDate> element.

The SIF specification defines the meaning of this element as: "Date course section ended, or will end."

Parameters:

value - A PartialDateType object

Since:

2.0

setEndDate

public void setEndDate(java.lang.String value)

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

Parameters:

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

Since:

2.0

getEndDate

public PartialDateType getEndDate()

Gets the value of the <EndDate> element.

The SIF specification defines the meaning of this element as: "Date course section ended, or will end."

Returns:

A PartialDateType object

Since:

2.0

removeEndDate

public void removeEndDate()

Removes the EndDate child element previously created by calling setEndDate

Since:

2.0

setMarkingPeriods

public void setMarkingPeriods(MarkingPeriods value)

Sets the value of the <MarkingPeriods> element.

Parameters:

value - A MarkingPeriods object

Since:

2.0

setMarkingPeriods

public void setMarkingPeriods(MarkingPeriod markingPeriod)

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

Parameters:

markingPeriod -

Since:

2.0

getMarkingPeriods

public MarkingPeriods getMarkingPeriods()

Gets the value of the <MarkingPeriods> element.

Returns:

A MarkingPeriods object

Since:

2.0

removeMarkingPeriods

public void removeMarkingPeriods()

Removes the MarkingPeriods child element previously created by calling setMarkingPeriods

Since:

2.0