com.edustructures.sifworks.etranscripts
Class StudentAcademicRecord

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFDataObject
              com.edustructures.sifworks.etranscripts.StudentAcademicRecord

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class StudentAcademicRecord
extends SIFDataObject

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

StudentAcademicRecord()
Constructor

StudentAcademicRecord(java.lang.String refId, java.lang.String sifRefId, TranscriptRecordRefObject sifRefObject)
Constructor that accepts values for all mandatory fields

Method Summary

AcademicPerformanceHistory	getAcademicPerformanceHistory() Gets the value of the <AcademicPerformanceHistory> element.
AcademicPerformanceSummary	getAcademicPerformanceSummary() Gets the value of the <AcademicPerformanceSummary> element.
ActivityAwardHistory	getActivityAwardHistory() Gets the value of the <ActivityAwardHistory> element.
AdditionalGraduationRequirementPerformanceHistory	getAdditionalGraduationRequirementPerformanceHistory() Gets the value of the <AdditionalGraduationRequirementPerformanceHistory> element.
AssessmentPerformanceHistory	getAssessmentPerformanceHistory() Gets the value of the <AssessmentPerformanceHistory> element.
CourseHistory	getCourseHistory() Gets the value of the <CourseHistory> element.
CurrentCourseActivity	getCurrentCourseActivity() Gets the value of the <CurrentCourseActivity> element.
PartialDateType	getDistrictEntryDate() Gets the value of the <DistrictEntryDate> element.
EnrollmentHistory	getEnrollmentHistory() Gets the value of the <EnrollmentHistory> 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.
java.util.Calendar	getReportingDate() Gets the value of the <ReportingDate> element.
SchoolAttendanceHistory	getSchoolAttendanceHistory() Gets the value of the <SchoolAttendanceHistory> element.
java.lang.String	getSIF_RefId() Gets the value of the SIF_RefId attribute.
java.lang.String	getSIF_RefObject() Gets the value of the SIF_RefObject attribute.
StudentSchoolEnrollmentData	getStudentSchoolEnrollmentData() Gets the value of the <StudentSchoolEnrollmentData> element.
void	removeAcademicPerformanceHistory() Removes the AcademicPerformanceHistory child element previously created by calling setAcademicPerformanceHistory
void	removeAcademicPerformanceSummary() Removes the AcademicPerformanceSummary child element previously created by calling setAcademicPerformanceSummary
void	removeActivityAwardHistory() Removes the ActivityAwardHistory child element previously created by calling setActivityAwardHistory
void	removeAdditionalGraduationRequirementPerformanceHistory() Removes the AdditionalGraduationRequirementPerformanceHistory child element previously created by calling setAdditionalGraduationRequirementPerformanceHistory
void	removeAssessmentPerformanceHistory() Removes the AssessmentPerformanceHistory child element previously created by calling setAssessmentPerformanceHistory
void	removeCourseHistory() Removes the CourseHistory child element previously created by calling setCourseHistory
void	removeCurrentCourseActivity() Removes the CurrentCourseActivity child element previously created by calling setCurrentCourseActivity
void	removeDistrictEntryDate() Removes the DistrictEntryDate child element previously created by calling setDistrictEntryDate
void	removeEnrollmentHistory() Removes the EnrollmentHistory child element previously created by calling setEnrollmentHistory
void	removeSchoolAttendanceHistory() Removes the SchoolAttendanceHistory child element previously created by calling setSchoolAttendanceHistory
void	removeStudentSchoolEnrollmentData() Removes the StudentSchoolEnrollmentData child element previously created by calling setStudentSchoolEnrollmentData
void	setAcademicPerformanceHistory(AcademicPerformanceHistory value) Sets the value of the <AcademicPerformanceHistory> element.
void	setAcademicPerformanceSummary(AcademicPerformanceSummary value) Sets the value of the <AcademicPerformanceSummary> element.
void	setActivityAwardHistory(ActivityAwardHistory value) Sets the value of the <ActivityAwardHistory> element.
void	setAdditionalGraduationRequirementPerformanceHistory(AdditionalGraduationRequirementPerformanceHistory value) Sets the value of the <AdditionalGraduationRequirementPerformanceHistory> element.
void	setAssessmentPerformanceHistory(AssessmentHistory assessment) Sets the value of the <AssessmentPerformanceHistory> child element.
void	setAssessmentPerformanceHistory(AssessmentPerformanceHistory value) Sets the value of the <AssessmentPerformanceHistory> element.
void	setCourseHistory(CourseHistory value) Sets the value of the <CourseHistory> element.
void	setCurrentCourseActivity(CurrentCourseActivity value) Sets the value of the <CurrentCourseActivity> element.
void	setDistrictEntryDate(PartialDateType value) Sets the value of the <DistrictEntryDate> element.
void	setDistrictEntryDate(java.lang.String value) Sets the value of the <DistrictEntryDate> child element.
void	setEnrollmentHistory(EnrollmentHistory value) Sets the value of the <EnrollmentHistory> element.
void	setRefId(java.lang.String value) Sets the value of the RefId attribute.
void	setReportingDate(java.util.Calendar value) Sets the value of the <ReportingDate> element.
void	setSchoolAttendanceHistory(SchoolAttendanceHistory value) Sets the value of the <SchoolAttendanceHistory> element.
void	setSIF_RefId(java.lang.String value) Sets the value of the SIF_RefId attribute.
void	setSIF_RefObject(java.lang.String value) Sets the value of the SIF_RefObject attribute as a String.
void	setSIF_RefObject(TranscriptRecordRefObject value) Sets the value of the SIF_RefObject attribute.
void	setStudentSchoolEnrollmentData(java.lang.String schoolAttendedRefId) Sets the value of the <StudentSchoolEnrollmentData> child element.
void	setStudentSchoolEnrollmentData(StudentSchoolEnrollmentData value) Sets the value of the <StudentSchoolEnrollmentData> 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

StudentAcademicRecord

public StudentAcademicRecord()

Constructor

StudentAcademicRecord

public StudentAcademicRecord(java.lang.String refId,
                             java.lang.String sifRefId,
                             TranscriptRecordRefObject sifRefObject)

Constructor that accepts values for all mandatory fields

Parameters:

refId - The ID (GUID) of this record.

sifRefId - The GUID of an associated object, either StudentRecordExchange or StudentPersonal.

sifRefObject - The associated object type.

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) of this record."

Overrides:

getRefId in class SIFDataObject

Returns:

The RefId attribute of this object.

Since:

2.0

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) of this record."

Parameters:

value - A String object

Since:

2.0

getSIF_RefId

public java.lang.String getSIF_RefId()

Gets the value of the SIF_RefId attribute.

The SIF specification defines the meaning of this attribute as: "The GUID of an associated object, either StudentRecordExchange or StudentPersonal."

Returns:

The SIF_RefId attribute of this object.

Since:

2.0

setSIF_RefId

public void setSIF_RefId(java.lang.String value)

Sets the value of the SIF_RefId attribute.

The SIF specification defines the meaning of this attribute as: "The GUID of an associated object, either StudentRecordExchange or StudentPersonal."

Parameters:

value - A String object

Since:

2.0

getSIF_RefObject

public java.lang.String getSIF_RefObject()

Gets the value of the SIF_RefObject attribute.

The SIF specification defines the meaning of this attribute as: "The associated object type."

Returns:

The SIF_RefObject attribute of this object.

Since:

2.0

setSIF_RefObject

public void setSIF_RefObject(TranscriptRecordRefObject value)

Sets the value of the SIF_RefObject attribute.

The SIF specification defines the meaning of this attribute as: "The associated object type."

Parameters:

value - A constant defined by the TranscriptRecordRefObject class

Since:

2.0

setSIF_RefObject

public void setSIF_RefObject(java.lang.String value)

Sets the value of the SIF_RefObject attribute as a String.

The SIF specification defines the meaning of this attribute as: "The associated object type."

Parameters:

value - The value as a String

Since:

2.0

getReportingDate

public java.util.Calendar getReportingDate()

Gets the value of the <ReportingDate> element.

The SIF specification defines the meaning of this element as: "The date this record was prepared."

Returns:

The ReportingDate element of this object.

Since:

2.0

setReportingDate

public void setReportingDate(java.util.Calendar value)

Sets the value of the <ReportingDate> element.

The SIF specification defines the meaning of this element as: "The date this record was prepared."

Parameters:

value - A Calendar object

Since:

2.0

setStudentSchoolEnrollmentData

public void setStudentSchoolEnrollmentData(StudentSchoolEnrollmentData value)

Sets the value of the <StudentSchoolEnrollmentData> element.

Parameters:

value - A StudentSchoolEnrollmentData object

Since:

2.0

setStudentSchoolEnrollmentData

public void setStudentSchoolEnrollmentData(java.lang.String schoolAttendedRefId)

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

Parameters:

schoolAttendedRefId - References the school of record for the student (see SchoolAttended).

Since:

2.0

getStudentSchoolEnrollmentData

public StudentSchoolEnrollmentData getStudentSchoolEnrollmentData()

Gets the value of the <StudentSchoolEnrollmentData> element.

Returns:

A StudentSchoolEnrollmentData object

Since:

2.0

removeStudentSchoolEnrollmentData

public void removeStudentSchoolEnrollmentData()

Removes the StudentSchoolEnrollmentData child element previously created by calling setStudentSchoolEnrollmentData

Since:

2.0

setDistrictEntryDate

public void setDistrictEntryDate(PartialDateType value)

Sets the value of the <DistrictEntryDate> element.

The SIF specification defines the meaning of this element as: "The date the student originally enrolled in the district of the school of record."

Parameters:

value - A PartialDateType object

Since:

2.0

setDistrictEntryDate

public void setDistrictEntryDate(java.lang.String value)

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

Parameters:

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

Since:

2.0

getDistrictEntryDate

public PartialDateType getDistrictEntryDate()

Gets the value of the <DistrictEntryDate> element.

The SIF specification defines the meaning of this element as: "The date the student originally enrolled in the district of the school of record."

Returns:

A PartialDateType object

Since:

2.0

removeDistrictEntryDate

public void removeDistrictEntryDate()

Removes the DistrictEntryDate child element previously created by calling setDistrictEntryDate

Since:

2.0

setSchoolAttendanceHistory

public void setSchoolAttendanceHistory(SchoolAttendanceHistory value)

Sets the value of the <SchoolAttendanceHistory> element.

Parameters:

value - A SchoolAttendanceHistory object

Since:

2.0

getSchoolAttendanceHistory

public SchoolAttendanceHistory getSchoolAttendanceHistory()

Gets the value of the <SchoolAttendanceHistory> element.

Returns:

A SchoolAttendanceHistory object

Since:

2.0

removeSchoolAttendanceHistory

public void removeSchoolAttendanceHistory()

Removes the SchoolAttendanceHistory child element previously created by calling setSchoolAttendanceHistory

Since:

2.0

setEnrollmentHistory

public void setEnrollmentHistory(EnrollmentHistory value)

Sets the value of the <EnrollmentHistory> element.

Parameters:

value - A EnrollmentHistory object

Since:

2.0

getEnrollmentHistory

public EnrollmentHistory getEnrollmentHistory()

Gets the value of the <EnrollmentHistory> element.

Returns:

An EnrollmentHistory object

Since:

2.0

removeEnrollmentHistory

public void removeEnrollmentHistory()

Removes the EnrollmentHistory child element previously created by calling setEnrollmentHistory

Since:

2.0

setCurrentCourseActivity

public void setCurrentCourseActivity(CurrentCourseActivity value)

Sets the value of the <CurrentCourseActivity> element.

Parameters:

value - A CurrentCourseActivity object

Since:

2.0

getCurrentCourseActivity

public CurrentCourseActivity getCurrentCourseActivity()

Gets the value of the <CurrentCourseActivity> element.

Returns:

A CurrentCourseActivity object

Since:

2.0

removeCurrentCourseActivity

public void removeCurrentCourseActivity()

Removes the CurrentCourseActivity child element previously created by calling setCurrentCourseActivity

Since:

2.0

setCourseHistory

public void setCourseHistory(CourseHistory value)

Sets the value of the <CourseHistory> element.

Parameters:

value - A CourseHistory object

Since:

2.0

getCourseHistory

public CourseHistory getCourseHistory()

Gets the value of the <CourseHistory> element.

Returns:

A CourseHistory object

Since:

2.0

removeCourseHistory

public void removeCourseHistory()

Removes the CourseHistory child element previously created by calling setCourseHistory

Since:

2.0

setAcademicPerformanceHistory

public void setAcademicPerformanceHistory(AcademicPerformanceHistory value)

Sets the value of the <AcademicPerformanceHistory> element.

Parameters:

value - A AcademicPerformanceHistory object

Since:

2.0

getAcademicPerformanceHistory

public AcademicPerformanceHistory getAcademicPerformanceHistory()

Gets the value of the <AcademicPerformanceHistory> element.

Returns:

An AcademicPerformanceHistory object

Since:

2.0

removeAcademicPerformanceHistory

public void removeAcademicPerformanceHistory()

Removes the AcademicPerformanceHistory child element previously created by calling setAcademicPerformanceHistory

Since:

2.0

setAcademicPerformanceSummary

public void setAcademicPerformanceSummary(AcademicPerformanceSummary value)

Sets the value of the <AcademicPerformanceSummary> element.

Parameters:

value - A AcademicPerformanceSummary object

Since:

2.0

getAcademicPerformanceSummary

public AcademicPerformanceSummary getAcademicPerformanceSummary()

Gets the value of the <AcademicPerformanceSummary> element.

Returns:

An AcademicPerformanceSummary object

Since:

2.0

removeAcademicPerformanceSummary

public void removeAcademicPerformanceSummary()

Removes the AcademicPerformanceSummary child element previously created by calling setAcademicPerformanceSummary

Since:

2.0

setAssessmentPerformanceHistory

public void setAssessmentPerformanceHistory(AssessmentPerformanceHistory value)

Sets the value of the <AssessmentPerformanceHistory> element.

Parameters:

value - A AssessmentPerformanceHistory object

Since:

2.0

setAssessmentPerformanceHistory

public void setAssessmentPerformanceHistory(AssessmentHistory assessment)

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

Parameters:

assessment -

Since:

2.0

getAssessmentPerformanceHistory

public AssessmentPerformanceHistory getAssessmentPerformanceHistory()

Gets the value of the <AssessmentPerformanceHistory> element.

Returns:

An AssessmentPerformanceHistory object

Since:

2.0

removeAssessmentPerformanceHistory

public void removeAssessmentPerformanceHistory()

Removes the AssessmentPerformanceHistory child element previously created by calling setAssessmentPerformanceHistory

Since:

2.0

setAdditionalGraduationRequirementPerformanceHistory

public void setAdditionalGraduationRequirementPerformanceHistory(AdditionalGraduationRequirementPerformanceHistory value)

Sets the value of the <AdditionalGraduationRequirementPerformanceHistory> element.

Parameters:

value - A AdditionalGraduationRequirementPerformanceHistory object

Since:

2.0

getAdditionalGraduationRequirementPerformanceHistory

public AdditionalGraduationRequirementPerformanceHistory getAdditionalGraduationRequirementPerformanceHistory()

Gets the value of the <AdditionalGraduationRequirementPerformanceHistory> element.

Returns:

An AdditionalGraduationRequirementPerformanceHistory object

Since:

2.0

removeAdditionalGraduationRequirementPerformanceHistory

public void removeAdditionalGraduationRequirementPerformanceHistory()

Removes the AdditionalGraduationRequirementPerformanceHistory child element previously created by calling setAdditionalGraduationRequirementPerformanceHistory

Since:

2.0

setActivityAwardHistory

public void setActivityAwardHistory(ActivityAwardHistory value)

Sets the value of the <ActivityAwardHistory> element.

Parameters:

value - A ActivityAwardHistory object

Since:

2.0

getActivityAwardHistory

public ActivityAwardHistory getActivityAwardHistory()

Gets the value of the <ActivityAwardHistory> element.

Returns:

An ActivityAwardHistory object

Since:

2.0

removeActivityAwardHistory

public void removeActivityAwardHistory()

Removes the ActivityAwardHistory child element previously created by calling setActivityAwardHistory

Since:

2.0