com.edustructures.sifworks.etranscripts
Class MarkingPeriod

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.etranscripts.MarkingPeriod

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class MarkingPeriod
extends SIFElement

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

MarkingPeriod()
Constructor

MarkingPeriod(GradeLevel gradeLevelWhenTaken, java.math.BigDecimal courseCreditsAttempted, java.math.BigDecimal courseCreditsEarned)
Constructor that accepts values for all mandatory fields

Method Summary

java.math.BigDecimal	getCourseCreditsAttempted() Gets the value of the <CourseCreditsAttempted> element.
java.math.BigDecimal	getCourseCreditsEarned() Gets the value of the <CourseCreditsEarned> element.
java.math.BigDecimal	getDaysAbsent() Gets the value of the <DaysAbsent> element.
java.math.BigDecimal	getDaysPresent() Gets the value of the <DaysPresent> element.
GradeLevel	getGradeLevelWhenTaken() Gets the value of the <GradeLevelWhenTaken> 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
MarkData	getMarkData() Gets the value of the <MarkData> element.
TermInfoData	getTermInfoData() Gets the value of the <TermInfoData> element.
void	removeGradeLevelWhenTaken() Removes the GradeLevelWhenTaken child element previously created by calling setGradeLevelWhenTaken
void	removeMarkData() Removes the MarkData child element previously created by calling setMarkData
void	removeTermInfoData() Removes the TermInfoData child element previously created by calling setTermInfoData
void	setCourseCreditsAttempted(java.math.BigDecimal value) Sets the value of the <CourseCreditsAttempted> element.
void	setCourseCreditsEarned(java.math.BigDecimal value) Sets the value of the <CourseCreditsEarned> element.
void	setDaysAbsent(java.math.BigDecimal value) Sets the value of the <DaysAbsent> element.
void	setDaysPresent(java.math.BigDecimal value) Sets the value of the <DaysPresent> element.
void	setGradeLevelWhenTaken(GradeLevel value) Sets the value of the <GradeLevelWhenTaken> element.
void	setGradeLevelWhenTaken(GradeLevelCode code) Sets the value of the <GradeLevelWhenTaken> child element.
void	setMarkData(MarkData value) Sets the value of the <MarkData> element.
void	setMarkData(java.lang.String markValueInfoDataRefId) Sets the value of the <MarkData> child element.
void	setTermInfoData(java.lang.String schoolAttendedRefId) Sets the value of the <TermInfoData> child element.
void	setTermInfoData(TermInfoData value) Sets the value of the <TermInfoData> 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

MarkingPeriod

public MarkingPeriod()

Constructor

MarkingPeriod

public MarkingPeriod(GradeLevel gradeLevelWhenTaken,
                     java.math.BigDecimal courseCreditsAttempted,
                     java.math.BigDecimal courseCreditsEarned)

Constructor that accepts values for all mandatory fields

Parameters:

gradeLevelWhenTaken - Student's grade level at time of course.

courseCreditsAttempted - Number of course credits attempted.

courseCreditsEarned - Number of course credits earned.

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

setTermInfoData

public void setTermInfoData(TermInfoData value)

Sets the value of the <TermInfoData> element.

Parameters:

value - A TermInfoData object

Since:

2.0

setTermInfoData

public void setTermInfoData(java.lang.String schoolAttendedRefId)

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

Parameters:

schoolAttendedRefId - Reference to the school of record for the courses being taken (see SchoolAttended).

Since:

2.0

getTermInfoData

public TermInfoData getTermInfoData()

Gets the value of the <TermInfoData> element.

Returns:

A TermInfoData object

Since:

2.0

removeTermInfoData

public void removeTermInfoData()

Removes the TermInfoData child element previously created by calling setTermInfoData

Since:

2.0

setGradeLevelWhenTaken

public void setGradeLevelWhenTaken(GradeLevel value)

Sets the value of the <GradeLevelWhenTaken> element.

The SIF specification defines the meaning of this element as: "Student's grade level at time of course."

Parameters:

value - A GradeLevel object

Since:

2.0

setGradeLevelWhenTaken

public void setGradeLevelWhenTaken(GradeLevelCode code)

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

Parameters:

code - Code representing the grade level.

Since:

2.0

getGradeLevelWhenTaken

public GradeLevel getGradeLevelWhenTaken()

Gets the value of the <GradeLevelWhenTaken> element.

The SIF specification defines the meaning of this element as: "Student's grade level at time of course."

Returns:

A GradeLevel object

Since:

2.0

removeGradeLevelWhenTaken

public void removeGradeLevelWhenTaken()

Removes the GradeLevelWhenTaken child element previously created by calling setGradeLevelWhenTaken

Since:

2.0

setMarkData

public void setMarkData(MarkData value)

Sets the value of the <MarkData> element.

Parameters:

value - A MarkData object

Since:

2.0

setMarkData

public void setMarkData(java.lang.String markValueInfoDataRefId)

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

Parameters:

markValueInfoDataRefId - Reference to marking system at school of record.

Since:

2.0

getMarkData

public MarkData getMarkData()

Gets the value of the <MarkData> element.

Returns:

A MarkData object

Since:

2.0

removeMarkData

public void removeMarkData()

Removes the MarkData child element previously created by calling setMarkData

Since:

2.0

getCourseCreditsAttempted

public java.math.BigDecimal getCourseCreditsAttempted()

Gets the value of the <CourseCreditsAttempted> element.

The SIF specification defines the meaning of this element as: "Number of course credits attempted."

Returns:

The CourseCreditsAttempted element of this object.

Since:

2.0

setCourseCreditsAttempted

public void setCourseCreditsAttempted(java.math.BigDecimal value)

Sets the value of the <CourseCreditsAttempted> element.

The SIF specification defines the meaning of this element as: "Number of course credits attempted."

Parameters:

value - A BigDecimal object

Since:

2.0

getCourseCreditsEarned

public java.math.BigDecimal getCourseCreditsEarned()

Gets the value of the <CourseCreditsEarned> element.

The SIF specification defines the meaning of this element as: "Number of course credits earned."

Returns:

The CourseCreditsEarned element of this object.

Since:

2.0

setCourseCreditsEarned

public void setCourseCreditsEarned(java.math.BigDecimal value)

Sets the value of the <CourseCreditsEarned> element.

The SIF specification defines the meaning of this element as: "Number of course credits earned."

Parameters:

value - A BigDecimal object

Since:

2.0

getDaysAbsent

public java.math.BigDecimal getDaysAbsent()

Gets the value of the <DaysAbsent> element.

Returns:

The DaysAbsent element of this object.

Since:

2.0

setDaysAbsent

public void setDaysAbsent(java.math.BigDecimal value)

Sets the value of the <DaysAbsent> element.

Parameters:

value - A BigDecimal object

Since:

2.0

getDaysPresent

public java.math.BigDecimal getDaysPresent()

Gets the value of the <DaysPresent> element.

Returns:

The DaysPresent element of this object.

Since:

2.0

setDaysPresent

public void setDaysPresent(java.math.BigDecimal value)

Sets the value of the <DaysPresent> element.

Parameters:

value - A BigDecimal object

Since:

2.0