OSID - osid.course.registration.Registration Service Interface Definition

Interface	osid.course.registration.Registration
Implements	`osid.OsidRelationship`
Used By	`osid.course.registration.RegistrationAdminSession`
	`osid.course.registration.RegistrationList`
	`osid.course.registration.RegistrationLookupSession`
	`osid.course.registration.request.RegistrationRequestItem`
	`osid.course.registration.request.RegistrationRequestItemSearchOrder`
Description	A `Registration` is an `OsidRelationship` between a student and a `CourseRegistration` for a `RegistrationTarget` .
Method	getCourseRegistrationId
Description	Gets the course registration `Id` associated with this registration.
Return	`osid.id.Id`		the course registration `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getCourseRegistration
Description	Gets the course registration associated with this registration.
Return	`osid.course.registration.CourseRegistration`		the course registration
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationTargetId
Description	Gets the registration target `Id` associated with this registration.
Return	`osid.id.Id`		the registration target `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationTarget
Description	Gets the registration target associated with this registration.
Return	`osid.course.registration.RegistrationTarget`		the registration target
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getStudentId
Description	Gets the `Id` of the student `Resource` .
Return	`osid.id.Id`		the `Student` `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getStudent
Description	Gets the student `Resource` .
Return	`osid.resource.Resource`		the student
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	definesCredits
Description	Tests if this registration defines credits to be earned.
Return	`boolean`		`true` if this registration has credits, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCredits
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.
Return	`decimal[]`		the number of credits
Errors	ILLEGAL_STATE		`definesCredits()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	isGraded
Description	Tests if this registration includes a specific grading option.
Return	`boolean`		`true` if this course is graded, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getGradingOptionId
Description	Gets the grading option `Id` for this registration.
Return	`osid.id.Id`		the grading option `Id`
Errors	ILLEGAL_STATE		`isGraded()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getGradingOption
Description	Gets the grading option for this registration.
Return	`osid.grading.GradeSystem`		a grading system
Errors	ILLEGAL_STATE		`isGraded()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationRecord
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` .
Parameters	`osid.type.Type`	`registrationRecordType`	the type of registration record to retrieve
Return	`osid.course.registration.records.RegistrationRecord`		the registration record
Errors	NULL_ARGUMENT		`registrationRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(registrationRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.