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

An ActivityRegistration is an OsidRelationship between a student and an Activity for a Registration.

MethodgetRegistrationId
Description

Gets the registration Id associated with this registration.

Returnosid.id.Idthe registration Id
CompliancemandatoryThis method must be implemented.
MethodgetRegistration
Description

Gets the registration associated with this registration.

Returnosid.course.registration.Registrationthe registration
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetActivityId
Description

Gets the activity Id associated with this registration.

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

Gets the activity associated with this registration.

Returnosid.course.Activitythe activity
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.
MethodgetActivityRegistrationRecord
Description

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

Parametersosid.type.TypeactivityRegistrationRecordTypethe type of activity registration record to retrieve
Returnosid.course.registration.records.ActivityRegistrationRecordthe activity registration record
ErrorsNULL_ARGUMENT activityRegistrationRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(activityRegistrationRecordType) is false
CompliancemandatoryThis method must be implemented.