OSID Logo
OSID Specifications
course registration package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.registration.Registration
Implementsosid.OsidRelationship
Description

A Registration is an OsidRelationship between a student and an ActivityBundle.

MethodgetActivityBundleId
Description

Gets the activity bundle Id associated with this registration.

Returnosid.id.Idthe activity bundle Id
CompliancemandatoryThis method must be implemented.
MethodgetActivityBundle
Description

Gets the activity bundle associated with this registration.

Returnosid.course.registration.ActivityBundlethe activity bundle
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetStudentId
Description

Gets the Id of the student Resource.

Returnosid.id.Idthe Student 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.
MethoddefinesCredits
Description

Tests if this registration defines credits to be earned.

Returnboolean true if this registration has credits, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCredits
Description

Gets the number of credits the student is registered to earn. Multiple credit options indicates a set of credits to be determined at the completion of the course.

Returndecimal[]the number of credits
ErrorsILLEGAL_STATE definesCredits() is false
CompliancemandatoryThis method must be implemented.
MethodisGraded
Description

Tests if this registration includes a specific grading option.

Returnboolean true if this course is graded, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetGradingOptionId
Description

Gets the grading option Id for this registration.

Returnosid.id.Idthe grading option Id
ErrorsILLEGAL_STATE isGraded() is false
CompliancemandatoryThis method must be implemented.
MethodgetGradingOption
Description

Gets the grading option for this registration.

Returnosid.grading.GradeSystema grading system
ErrorsILLEGAL_STATE isGraded() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetRegistrationRecord
Description

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

Parametersosid.type.TyperegistrationRecordTypethe type of registration record to retrieve
Returnosid.course.registration.records.RegistrationRecordthe registration record
ErrorsNULL_ARGUMENT registrationRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(registrationRecordType) is false
CompliancemandatoryThis method must be implemented.