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

Interface	osid.course.requisite.Requisite
Implements	`osid.OsidRule`
	`osid.OsidEnabler`
	`osid.Containable`
Description	A `Requisite` represents a requirement. A `Requisite` has 8 terms for evaluation that must all be true for this `Requisite` to be satisfied. Additional terms may be defined in the `RequisiteRecord.` CourseRequirements ProgramRequirements CredentialRequirements AssessmentRequirements AwardRequirements LearningObjectiveRequirements an external `Rule` Requisite options for nested `OR` terms A `Requsite` is true if the active `Requisite` options term `AND` the `CourseRequirements` term `AND` the `ProgramRequirements` term AND `CredentialRequirements` term `AND` the `AssessemnetRequirements` term `AND` the `LearningObjectiveRequirements` AND `Rule` are all `true.` `Requisites` are also `OsidEnablers` that have effectiveness and may apply to specific populations of students.
Method	hasRequisiteOptions
Description	Tests if any requisite options are defined. If no requisite options are defined, this requisite term evaluates to `true.` If requisite options are defined, then at least one `Requisite` must evaluate to `true` for the requisite option term to be `true.`
Return	`boolean`		`true` if any requisite options are defined, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRequisiteOptions
Description	Gets the requisite options for the `Requisite` options term. If any active requisite options are available, meeting the requirements of any one of these requisite options evaluates this requisite options term as `true.` If no active requisite options apply then this term evaluates to `false.`
Return	`osid.course.requisite.Requisite[]`		the requsites
Errors	ILLEGAL_STATE		`hasRequisiteOptions()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	hasCourseRequirements
Description	Tests if any course requirements are defined. If no course requirements are defined, this course requirements term evaluates to `true.` If course requirements are defined, then at least one `CourseRequirement` must evaluate to `true` for the course requirement term to be `true.`
Return	`boolean`		`true` if any course requirements are defined, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCourseRequirements
Description	Gets the course requirements term. If any `CourseRequirements` are available, meeting the requirements of any one of the `CourseRequirements` evaluates this course requirements term as `true.` If no active course requirements apply then this course requirements term is `false.`
Return	`osid.course.requisite.CourseRequirement[]`		the course requirements
Errors	ILLEGAL_STATE		`hasCourseRequirements()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	hasProgramRequirements
Description	Tests if any program requirements are defined. If no program requirements are defined, this program requirements term evaluates to `true.` If program requirements are defined, then at least one `ProgramRequirement` must evaluate to `true` for the program requirement term to be `true.`
Return	`boolean`		`true` if any program requirements are defined, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProgramRequirements
Description	Gets the program requirements term. If any `ProgramRequirements` are available, meeting the requirements of any one of the `ProgramRequirements` evaluates this program requirements term as `true.` If no program requirements apply then this program requirements term evaluates to `false.`
Return	`osid.course.requisite.ProgramRequirement[]`		the program requirements
Errors	ILLEGAL_STATE		`hasProgramRequirements()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	hasCredentialRequirements
Description	Tests if any credential requirements are defined. If no credential requirements are defined, this credential requirements term evaluates to `true.` If credential requirements are defined, then at least one `CredentialRequirement` must evaluate to `true` for the credential requirement term to be `true.`
Return	`boolean`		`true` if any credential requirements are defined, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCredentialRequirements
Description	Gets the credential requirements term. If any `CredentialRequirements` are available, meeting the requirements of any one of the `CredentialRequirements` evaluates this credential requirements term as `true.` If no credential requirements are available, this credential requirements term evaluates to `false.`
Return	`osid.course.requisite.CredentialRequirement[]`		the credential requirements
Errors	ILLEGAL_STATE		`hasCredentialRequirements()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	hasLearningObjectiveRequirements
Description	Tests if any learning objective requirements are defined. If no learning objective requirements are defined, this learning objective requirements term evaluates to `true.` If learning objective requirements are defined, then at least one `LearningObjectiveRequirement` must evaluate to `true` for the learning objective requirement term to be `true.`
Return	`boolean`		`true` if any learning objective requirements are defined, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getLearningObjectiveRequirements
Description	Gets the learning objective requirements term. If any `LearningObjectiveRequirements` are available, meeting the requirements of any one of the `LearningObjectiveRequirements` evaluates this learning objective requirements term as `true.` If no learning objective requirements applythen this learning objective requirements term evaluates to `false.`
Return	`osid.course.requisite.LearningObjectiveRequirement[]`		the learning objective requirements
Errors	ILLEGAL_STATE		`hasLearningObjectiveRequirements()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	hasAssessmentRequirements
Description	Tests if any assessment requirements are defined. If no assessment requirements are defined, this assessment requirements term evaluates to `true.` If assessment requirements are defined, then at least one `AssessmentRequirement` must evaluate to `true` for the assessment requirement term to be `true.`
Return	`boolean`		`true` if any assessment requirements are defined, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentRequirements
Description	Gets the assessment requirements term. If any `AssessmentRequirements` are available, meeting the requirements of any one of the `AssessmentRequirements` evaluates this assessment requirements term as `true.` If no assessment requirements are available, this assessment requirements term evaluates to `false.`
Return	`osid.course.requisite.AssessmentRequirement[]`		the assessment requirements
Errors	ILLEGAL_STATE		`hasAssessmentRequirements()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	hasAwardRequirements
Description	Tests if any award requirements are defined. If no award requirements are defined, this award requirements term evaluates to `true.` If award requirements are defined, then at least one `AwardRequirement` must evaluate to `true` for the award requirement term to be `true.`
Return	`boolean`		`true` if any award requirements are defined, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAwardRequirements
Description	Gets the award requirements term. If any `AwardRequirements` are available, meeting the requirements of any one of the `AwardRequirements` evaluates this award requirements term as `true.` If no award requirements are available, this award requirements term evaluates to `false.`
Return	`osid.course.requisite.AwardRequirement[]`		the award requirements
Errors	ILLEGAL_STATE		`hasAwardRequirements()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getRequisiteRecord
Description	Gets the requisite record corresponding to the given `Requisite` record `Type.` This method is used to retrieve an object implementing the requested record. The `requisiteRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(requisiteRecordType)` is `true` .
Parameters	`osid.type.Type`	`requisiteRecordType`	the type of requisite record to retrieve
Return	`osid.course.requisite.records.RequisiteRecord`		the requisite record
Errors	NULL_ARGUMENT		`requisiteRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(requisiteRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.