Docs For Class EnrollmentRecord

Description

EnrollmentRecord stores a student (Agent) and an Enrollment Status Type.

The EnrollmentRecord is the result of adding or changing a student in a CourseSection. If the student is removed from the CourseSection, there will no longer be an EnrollmentRecord for the student. The joining of a status type to a student allows for the characterization of the student. For example, students might be added as regular students or auditing. Students might be on the enrollment list, but their status might be withdrawn passing or withdrawn failing, etc.

<p> OSID Version: 2.0 </p>

<p> Licensed under the org.osid.SidImplementationLicenseMIT. </p>

Located in /harmoni/oki2/osid/coursemanagement/EnrollmentRecord.php (line 24)

Direct descendents

Class	Description
HarmoniEnrollmentRecord	EnrollmentRecord stores a student (Agent) and an Enrollment Status Type.

Method Summary

object Type getStatus ()

object Id getStudent ()

Methods

getStatus (line 74)

Get the Status Type for a student. Students Status Type is supplied when the student is added or changed in the CourseSection. The CourseManagementManager returns the Status Types supported by this implementation.

access: public
throws: object CourseManagementException An exception with one of the following messages defined in org.osid.coursemanagement.CourseManagementException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object Type getStatus ()

Redefined in descendants as:

HarmoniEnrollmentRecord::getStatus() : Get the Status Type for a student. Students Status Type is supplied when the student is added or changed in the CourseSection. The CourseManagementManager returns the Status Types supported by this implementation.

getStudent (line 47)

Get the Id of the Agent representing a student enrolled in the CourseSection.

access: public
throws: object CourseManagementException An exception with one of the following messages defined in org.osid.coursemanagement.CourseManagementException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object Id getStudent ()

Redefined in descendants as:

HarmoniEnrollmentRecord::getStudent() : Get the Id of the Agent representing a student enrolled in the CourseSection.