OSID - osid.course.requisite.CourseRequirement Service Interface Definition

Interface	osid.course.requisite.CourseRequirement
Implements	`osid.OsidRule`
Implements	`osid.Aggregateable`
Description	A `CourseRequirement` is an `OsidRule` and represents a requirement based on the completion or a co-requsite of a course.
Method	getAltRequisites
Description	Gets any `Requisites` that may be substituted in place of this `CourseRequirement.` All `Requisites` must be satisifed to be a substitute for this course requirement. Inactive `Requisites` are not evaluated but if no applicable requisite exists, then the alternate requisite is not satisifed.
Return	`osid.course.requisite.Requisite[]`		the alternate requisites
Compliance	`mandatory`		This method must be implemented.
Method	getCourseId
Description	Gets the `Id` of the `Course.`
Return	`osid.id.Id`		the course `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getCourse
Description	Gets the `Course.`
Return	`osid.course.Course`		the course
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	requiresCompletion
Description	Tests if this requirement requires completion of the course with a passing grade.
Return	`boolean`		`true` if a completion of the course is required, `false` is the course is a co-requisite
Compliance	`mandatory`		This method must be implemented.
Method	hasTimeframe
Description	Tests if the course must be completed within the required duration.
Return	`boolean`		`true` if the course must be completed within a required time, `false` if it could have been completed at any time in the past
Compliance	`mandatory`		This method must be implemented.
Method	getTimeframe
Description	Gets the timeframe in which the course has to be completed. A negative duration indicates the course had to be completed within the specified amount of time in the past. A posiitive duration indicates the course must be completed within the specified amount of time in the future. A zero duration indicates the course must be completed in the current term.
Return	`osid.calendaring.Duration`		the time frame
Errors	ILLEGAL_STATE		`hasTimeframe()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	hasMinimumGrade
Description	Tests if a minimum grade above passing is required in the completion of the course or maintained at this level during a co-requisite.
Return	`boolean`		`true` if a minimum grade is required, `false` if the course just has to be passed
Compliance	`mandatory`		This method must be implemented.
Method	getMinimumGradeId
Description	Gets the minimum grade `Id.`
Return	`osid.id.Id`		the minimum grade `Id`
Errors	ILLEGAL_STATE		`hasMinimumGrade()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getMinimumGrade
Description	Gets the minimum grade.
Return	`osid.grading.Grade`		the minimum grade
Errors	ILLEGAL_STATE		`hasMinimumGrade()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	hasMinimumScore
Description	Tests if a minimum score above passing is required in the completion of the course or maintained at this level during a co-requisite.
Return	`boolean`		`true` if a minimum score is required, `false` if the course just has to be passed
Compliance	`mandatory`		This method must be implemented.
Method	getMinimumScoreSystemId
Description	Gets the scoring system `Id` for the minimum score.
Return	`osid.id.Id`		the scoring system `Id`
Errors	ILLEGAL_STATE		`hasMinimumScore()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getMinimumScoreSystem
Description	Gets the scoring system for the minimum score.
Return	`osid.grading.GradeSystem`		the scoring system
Errors	ILLEGAL_STATE		`hasMinimumScore()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getMinimumScore
Description	Gets the minimum score.
Return	`decimal`		the minimum score
Errors	ILLEGAL_STATE		`hasMinimumScore()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	hasMinimumEarnedCredits
Description	Tests if a minimum credits earned from the completion of the course, or registered for in a co-requisite is required.
Return	`boolean`		`true` if a minimum credits is required, `false` otehrwise
Compliance	`mandatory`		This method must be implemented.
Method	getMinimumEarnedCredits
Description	Gets the minimum earned credits.
Return	`decimal`		the minimum credits
Errors	ILLEGAL_STATE		`hasMinimumEarnedCredits()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getCourseRequirementRecord
Description	Gets the course requirement record corresponding to the given `CourseRequirement` record `Type.` This method is used to retrieve an object implementing the requested record. The `courseRequirementRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(courseRequirementRecordType)` is `true` .
Parameters	`osid.type.Type`	`courseRequirementRecordType`	the type of course requirement record to retrieve
Return	`osid.course.requisite.records.CourseRequirementRecord`		the course requirement record
Errors	NULL_ARGUMENT		`courseRequirementRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(courseRequirementRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.