OSID Logo
OSID Specifications
course program package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.program.Enrollment
Implementsosid.OsidRelationship
Description

An Enrollment is an OsidRelationship between a student and a ProgramOffering.

MethodgetProgramOfferingId
Description

Gets the program offering Id associated with this registration.

Returnosid.id.Idthe program offering Id
CompliancemandatoryThis method must be implemented.
MethodgetProgramOffering
Description

Gets the program offering associated with this registration.

Returnosid.course.program.ProgramOfferingthe program offering
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetStudentId
Description

Gets the Id of the student Resource.

Returnosid.id.Idthe Resource Id
CompliancemandatoryThis method must be implemented.
MethodgetStudent
Description

Gets the student Resource.

Returnosid.resource.Resourcethe student
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetEnrollmentRecord
Description

Gets the enrollment record corresponding to the given Enrollment record Type. This method is used to retrieve an object implementing the requested record. The enrollmentRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(enrollmentRecordType) is true .

Parametersosid.type.TypeenrollmentRecordTypethe type of enrollment record to retrieve
Returnosid.course.program.records.EnrollmentRecordthe enrollment record
ErrorsNULL_ARGUMENT enrollmentRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(enrollmentRecordType) is false
CompliancemandatoryThis method must be implemented.