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

Interface	osid.course.requisite.CourseRequirement
Implements	`osid.OsidRule`
Implements	`osid.Aggregateable`
Used By	`osid.course.requisite.CourseRequirementList`
	`osid.course.requisite.Requisite`
	`osid.course.requisite.RequisiteAdminSession`
	`osid.course.requisite.RequisiteLookupSession`
Description	A `CourseRequirement` is an `OsidRule` and represents a requirement based on the completion or a co-requisite 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	getCourseIds
Description	Gets the `Ids` of the `Courses`.
Return	`osid.id.IdList`		the course `Ids`
Compliance	`mandatory`		This method must be implemented.
Method	getCourses
Description	Gets the `Courses`. If `requiresMinimumNumber()` and `requiresMinimumCredits()` are both `false`, then all `Courses` in this set must be completed for this requirement.
Return	`osid.course.CourseList`		the courses
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	requiresSubjectArea
Description	Tests if any `Course` tagged in a subject area is required.
Return	`boolean`		`true` if a subject area is required, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSubjectAreaId
Description	Gets the subject area `Id`.
Return	`osid.id.Id`		the subject area `Id`
Errors	ILLEGAL_STATE		`requiresSubjectArea()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getSubjectArea
Description	Gets the subject area.
Return	`osid.ontology.Subject`		the subject area
Errors	ILLEGAL_STATE		`requiresSubjectArea()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	includeEquivalentUnits
Description	Tests if equivalent `Courses` to the ones specified satisfy this requirement.
Return	`boolean`		`true` if equivalent courses are acceptable, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	requiresMinimumNumber
Description	Tests if a minimum number of `Courses` from the set must be completed to satisfy this `CourseRequisite`.
Return	`boolean`		`true` if a minimum number of courses is required, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getMinimumNumber
Description	The minimum number of `Courses` in this `CourseRequisite` to complete from the set.
Return	`cardinal`		the minimum number of courses
Errors	ILLEGAL_STATE		`requiresMinimumNumber()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	requiresMinimumNonTransferNumber
Description	Tests if there is a minimum number of non-transfer `Courses` required to complete from the set.
Return	`boolean`		`true` if a minimum number of non-transfer courses is required, `false` otherwise
Errors	ILLEGAL_STATE		`requiresMinimumNumber()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getMinimumNonTransferNumber
Description	The minimum number of non-transfer `Courses` required from the set.
Return	`cardinal`		the minimum number of non-transfer courses
Errors	ILLEGAL_STATE		`requiresMinimumNonTransferNumber()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	hasTargetNumberForSet
Description	Tests if the set should contain a minimum number of `Courses` to be a valid requirement.
Return	`boolean`		`true` if the set has a minimum course count, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTargetSetNumber
Description	The minimum number of courses in the set to be a valid requirement.
Return	`cardinal`		the minimum number of courses in the set
Errors	ILLEGAL_STATE		`hasTargetNumberForSet()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	requiresMinimumCredits
Description	Tests if a minimum number of credits must be completed from the set of `Courses` to satisfy this requirement.
Return	`boolean`		`true` if a minimum number of credits is required, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCreditScaleId
Description	The `Id` of the credit scale of the minimum credits.
Return	`osid.id.Id`		the credit scale `Id`
Errors	ILLEGAL_STATE		`requiresMinimumCredits()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getCreditScale
Description	The credit scale of the minimum credits.
Return	`osid.grading.GradeSystem`		the credit scale
Errors	ILLEGAL_STATE		`requiresMinimumCredits()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getMinimumCredits
Description	The minimum number of credits that must be completed from the set of `Courses` to satisfy this requirement.
Return	`decimal`		the minimum credits
Errors	ILLEGAL_STATE		`requiresMinimumCredits()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	requiresMinimumNonTransferCredits
Description	Tests if a minimum number of non-transfer credits must be completed from the set of `Courses` to satisfy this requirement.
Return	`boolean`		`true` if a minimum number of non-transfer credits is required, `false` otherwise
Errors	ILLEGAL_STATE		`requiresMinimumCredits()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getNonTransferCredits
Description	The minimum number of non-transfer credits that must be completed from the set of `Courses` to satisfy this requirement.
Return	`decimal`		the minimum non-transfer credits
Errors	ILLEGAL_STATE		`requiresMinimumNonTransferCredits()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	hasTargetCreditsForSet
Description	Tests if the set should contain a minimum number of `Course` credits to be a valid requirement.
Return	`boolean`		`true` if the set has a minimum credit count, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTargetSetCredits
Description	The minimum number of `Course` credits to be a valid requirement.
Return	`decimal`		the minimum credits in the set
Errors	ILLEGAL_STATE		`hasTargetCreditsForSet()` is `false`
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.