Docs For Class HarmoniEnrollmentRecord

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>

version: $Id: EnrollmentRecord.class.php,v 1.11 2007/09/04 20:25:39 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Located in /harmoni/core/oki2/coursemanagement/EnrollmentRecord.class.php (line 26)

EnrollmentRecord
   |
   --HarmoniEnrollmentRecord

Variable Summary

mixed $_id

mixed $_table

Method Summary

void HarmoniEnrollmentRecord (mixed $id, object Id $id )

object CourseSection getCourseSection ()

object Type getStatus ()

object Id getStudent ()

void _getField (mixed $key)

void _getType (mixed $typename)

void _getTypes (mixed $typename)

void _setField (mixed $key, mixed $value)

void _typeToIndex (mixed $typename, mixed $type)

Variables

mixed $_id (line 36)

access: private

mixed $_table (line 37)

Methods

Constructor HarmoniEnrollmentRecord (line 47)

The constructor.

access: public

void HarmoniEnrollmentRecord (mixed $id, object Id $id )

object Id $id

getCourseSection (line 107)

Get the CourseSection that this EnrollmentRecord enrolls the student in.

WARNING: NOT IN OSID -- USE AT YOUR OWN RISK

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 CourseSection getCourseSection ()

getStatus (line 139)

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 ()

Redefinition of:

EnrollmentRecord::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 76)

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 ()

Redefinition of:

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

_getField (line 158)

void _getField (mixed $key)

_getType (line 165)

void _getType (mixed $typename)

_getTypes (line 152)

void _getTypes (mixed $typename)

_setField (line 170)

void _setField (mixed $key, mixed $value)

_typeToIndex (line 146)

void _typeToIndex (mixed $typename, mixed $type)

Inherited Methods

Inherited From EnrollmentRecord

EnrollmentRecord::getStatus()
EnrollmentRecord::getStudent()