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

Interface	osid.course.requisite.LearningObjectiveRequirement
Implements	`osid.OsidRule`
Implements	`osid.Aggregateable`
Used By	`osid.course.requisite.LearningObjectiveRequirementList`
	`osid.course.requisite.Requisite`
	`osid.course.requisite.RequisiteAdminSession`
	`osid.course.requisite.RequisiteLookupSession`
Description	A `LearningObjectiveRequirement` is an `OsidRule` and represents a requirement based on a set of learning `Objectives`. Like all `OsidObjects`, `LearningObjectiveRequirement` 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 `LearningObjectiveRequirement`. One or more `Requisites` must be satisifed to be a substitute for this learning objective requirement. Inactive `Requisites` are not evaluated but if no active requisite exists, then this term is ignored.
Return	`osid.course.requisite.Requisite[]`		the alternate requisites
Compliance	`mandatory`		This method must be implemented.
Method	getLearningObjectiveIds
Description	Gets the `Ids` of the `LearningObjectives`.
Return	`osid.id.IdList`		the learning objective `Ids`
Compliance	`mandatory`		This method must be implemented.
Method	getLearningObjectives
Description	Gets the `LearningObjectives`. If `requiresMinimumNumber()` is `false` , then all `LearningObjectives` in this set must be completed for this requirement.
Return	`osid.learning.ObjectiveList`		the learning objectives
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	includeEquivalentUnits
Description	Tests if equivalent `LearningObjectives` to the ones specified satisfy this requirement.
Return	`boolean`		`true` if equivalent learning objectives are acceptable, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	requiresMinimumNumber
Description	Tests if a minimum number of `LearningObjectives` from the set must be completed to satisfy this `LearningObjectiveRequirement`.
Return	`boolean`		`true` if a minimum number of learning objectives is required, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getMinimumNumber
Description	The minimum number of `LearningObjectives` in this `LearningObjectiveRequirement` to complete from the set.
Return	`cardinal`		the minimum number of learning objectives
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 `LearningObjectives` to be a valid requirement.
Return	`boolean`		`true` if the set has a minimum learning objective count, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTargetSetNumber
Description	The minimum number of learning objectives in the set to be a valid requirement.
Return	`cardinal`		the minimum number of learning objectives in the set
Errors	ILLEGAL_STATE		`hasTargetNumberForSet()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	hasMinimumProficiency
Description	Tests if a minimum grade in proficency is required for this learning objective.
Return	`boolean`		`true` if a minimum proficiency is required, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getMinimumProficiencyId
Description	Gets the minimum proficiency expressed as a `Grade`.
Return	`osid.id.Id`		the minimum proficiency
Errors	ILLEGAL_STATE		`hasMinimumProficiency()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getMinimumProficiency
Description	Gets the minimum proficiency expressed as a `Grade`.
Return	`osid.grading.Grade`		the minimum proficiency
Errors	ILLEGAL_STATE		`hasMinimumProficiency()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getLearningObjectiveRequirementRecord
Description	Gets the learning objective requirement record corresponding to the given `LearningObjectiveRequirement` record `Type`. This method is used to retrieve an object implementing the requested record. The `learningObjectiveRequirementRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(learningObjectiveRequirementRecordType)` is `true`.
Parameters	`osid.type.Type`	`learningObjectiveRequirementRecordType`	the type of learning objective requirement record to retrieve
Return	`osid.course.requisite.records.LearningObjectiveRequirementRecord`		the learning objective requirement record
Errors	NULL_ARGUMENT		`learningObjectiveRequirementRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(learningObjectiveRequirementRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.