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

Interface	osid.course.requisite.AssessmentRequirement
Implements	`osid.OsidRule`
Implements	`osid.Aggregateable`
Used By	`osid.course.requisite.AssessmentRequirementList`
	`osid.course.requisite.Requisite`
	`osid.course.requisite.RequisiteAdminSession`
	`osid.course.requisite.RequisiteLookupSession`
Description	A `AssessmentRequirement` is an `OsidRule` and represents a requirement based on a set of `Assessments`. Like all `OsidObjects`, `AssessmentRequirement` is managed by its `OsidSessions` and may not be accessed by concurrent processing threads.
Method	getAltRequisites
Description	Gets any `Requisites` that may be substituted in place of this `AssessmentRequirement`. One or more `Requisites` must be satisifed to be a substitute for this assessment requirement. Inactive `Requisites` are not evaluated but if no active requisite exists, then thhis term is ignored.
Return	`osid.course.requisite.Requisite[]`		the alternate requisites
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentIds
Description	Gets the `Ids` of the `Assessments`.
Return	`osid.id.IdList`		the assessment `Ids`
Compliance	`mandatory`		This method must be implemented.
Method	getAssessments
Description	Gets the `Assessments`. If `requiresMinimumNumber()` is `false` , then all `Assessments` in this set must be completed for this requirement.
Return	`osid.assessment.AssessmentList`		the assessments
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	includeEquivalentUnits
Description	Tests if equivalent `Assessments` to the ones specified satisfy this requirement.
Return	`boolean`		`true` if equivalent assessments are acceptable, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	requiresMinimumNumber
Description	Tests if a minimum number of `Assessments` from the set must be completed to satisfy this `AssessmentRequirement`.
Return	`boolean`		`true` if a minimum number of assessments is required, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getMinimumNumber
Description	The minimum number of `Assessments` in this `AssessmentRequirement` to complete from the set.
Return	`cardinal`		the minimum number of assessments
Errors	ILLEGAL_STATE		`requiresMinimumNumber()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	hasTargetNumberForSet
Description	Tests if the set should contain a minimum number of `Assessments` to be a valid requirement.
Return	`boolean`		`true` if the set has a minimum assessment count, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTargetSetNumber
Description	The minimum number of assessments in the set to be a valid requirement.
Return	`cardinal`		the minimum number of assessments in the set
Errors	ILLEGAL_STATE		`hasTargetNumberForSet()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	hasTimeframe
Description	Tests if the assessment must be completed within the required duration.
Return	`boolean`		`true` if the assessment has to 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 assessment has to be completed. A negative duration indicates the assessment had to be completed within the specified amount of time in the past. A posiitive duration indicates the assessment must be completed within the specified amount of time in the future. A zero duration indicates the assessment 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 assessment.
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 assessment.
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	getAssessmentRequirementRecord
Description	Gets the assessment requirement record corresponding to the given `AssessmentRequirement` record `Type`. This method is used to retrieve an object implementing the requested record. The `assessmentRequirementRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(assessmentRequirementRecordType)` is `true`.
Parameters	`osid.type.Type`	`assessmentRequirementRecordType`	the type of assessment requirement record to retrieve
Return	`osid.course.requisite.records.AssessmentRequirementRecord`		the assessment requirement record
Errors	NULL_ARGUMENT		`assessmentRequirementRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(assessmentRequirementRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.