OSID Logo
OSID Specifications
course requisite package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.requisite.RequisiteQuery
Implementsosid.OsidRuleQuery
osid.OsidEnablerQuery
osid.OsidContainableQuery
Description

This is the query for searching requisites. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchRequisiteOptionId
Description

Sets the requisite Id for this query to match requisites that a requisite option.

Parametersosid.id.IdrequisiteIda requisite Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT requisiteId is null
CompliancemandatoryThis method must be implemented.
MethodclearRequisiteOptionIdTerms
Description

Clears the requisite Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRequisiteOptionQuery
Description

Tests if a RequisiteQuery is available.

Returnboolean true if a requisite query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRequisiteOptionQuery
Description

Gets the query for a requisite option. Multiple retrievals produce a nested OR term.

Returnosid.course.requisite.RequisiteQuerya requisite query
ErrorsUNIMPLEMENTED supportsRequisiteOptionQuery() is false
ComplianceoptionalThis method must be implemented if supportsRequisiteOptionQuery() is true.
MethodmatchAnyRequisiteOption
Description

Matches requisites that have any requisite option.

Parametersbooleanmatch true to match requisites with any requisite option, false to match requisites with no requisite options
CompliancemandatoryThis method must be implemented.
MethodclearRequisiteOptionTerms
Description

Clears the requisite option terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCourseId
Description

Sets the course Id for this query to match requisites that have a requirement for the given course.

Parametersosid.id.IdcourseIda course Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT courseId is null
CompliancemandatoryThis method must be implemented.
MethodclearCourseIdTerms
Description

Clears the course Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsCourseQuery
Description

Tests if a CourseQuery is available.

Returnboolean true if a course query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCourseQuery
Description

Gets the query for a course requirement. Multiple retrievals produce a nested OR term.

Returnosid.course.CourseQuerya course query
ErrorsUNIMPLEMENTED supportsCourseQuery() is false
ComplianceoptionalThis method must be implemented if supportsCourseQuery() is true.
MethodmatchAnyCourse
Description

Matches requisites that have any course requirement.

Parametersbooleanmatch true to match requisites with any course requirement, false to match requisites with no course requirements
CompliancemandatoryThis method must be implemented.
MethodclearCourseTerms
Description

Clears the course terms.

CompliancemandatoryThis method must be implemented.
MethodmatchProgramId
Description

Sets the program Id for this query to match requisites that have a requirement for the given program.

Parametersosid.id.IdprogramIda program Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT programId is null
CompliancemandatoryThis method must be implemented.
MethodclearProgramIdTerms
Description

Clears the program Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsProgramQuery
Description

Tests if a ProgramQuery is available.

Returnboolean true if a program query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetProgramQuery
Description

Gets the query for a program requirement. Multiple retrievals produce a nested OR term.

Returnosid.course.program.ProgramQuerya program query
ErrorsUNIMPLEMENTED supportsProgramQuery() is false
ComplianceoptionalThis method must be implemented if supportsProgramQuery() is true.
MethodmatchAnyProgram
Description

Matches requisites that have any program requirement.

Parametersbooleanmatch true to match requisites with any program requirement, false to match requisites with no program requirements
CompliancemandatoryThis method must be implemented.
MethodclearProgramTerms
Description

Clears the program terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCredentialId
Description

Sets the credential Id for this query to match requisites that have a requirement for the given credential.

Parametersosid.id.IdcredentialIda credential Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT credentialId is null
CompliancemandatoryThis method must be implemented.
MethodclearCredentialIdTerms
Description

Clears the credential Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsCredentialQuery
Description

Tests if a CredentialQuery is available.

Returnboolean true if a credential query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCredentialQuery
Description

Gets the query for a credential requirement. Multiple retrievals produce a nested OR term.

Returnosid.course.program.CredentialQuerya credential query
ErrorsUNIMPLEMENTED supportsCredentialQuery() is false
ComplianceoptionalThis method must be implemented if supportsCredentialQuery() is true.
MethodmatchAnyCredential
Description

Matches requisites that have any credential requirement.

Parametersbooleanmatch true to match requisites with any credential requirement, false to match requisites with no credential requirements
CompliancemandatoryThis method must be implemented.
MethodclearCredentialTerms
Description

Clears the credential terms.

CompliancemandatoryThis method must be implemented.
MethodmatchLearningObjectiveId
Description

Sets the learning objective Id for this query to match requisites that have a requirement for the given learning objective.

Parametersosid.id.IdobjectiveIda learning objective Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT objectiveId is null
CompliancemandatoryThis method must be implemented.
MethodclearLearningObjectiveIdTerms
Description

Clears the learning objective Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsLearningObjectiveQuery
Description

Tests if a LearningObjectiveQuery is available.

Returnboolean true if a learning objective query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetLearningObjectiveQuery
Description

Gets the query for a learning objective requirement. Multiple retrievals produce a nested OR term.

Returnosid.learning.ObjectiveQuerya learning objective query
ErrorsUNIMPLEMENTED supportsLearningObjectiveQuery() is false
ComplianceoptionalThis method must be implemented if supportsLearningObjectiveQuery() is true.
MethodmatchAnyLearningObjective
Description

Matches requisites that have any learning objective requirement.

Parametersbooleanmatch true to match requisites with any learning objective requirement, false to match requisites with no learning objective requirements
CompliancemandatoryThis method must be implemented.
MethodclearLearningObjectiveTerms
Description

Clears the learning objective terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAssessmentId
Description

Sets the assessment Id for this query to match requisites that have a requirement for the given assessment.

Parametersosid.id.IdassessmentIdan assessment Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT assessmentId is null
CompliancemandatoryThis method must be implemented.
MethodclearAssessmentIdTerms
Description

Clears the assessment Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAssessmentQuery
Description

Tests if an AssessmentQuery is available.

Returnboolean true if an assessment query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentQuery
Description

Gets the query for a assessment requirement. Multiple retrievals produce a nested OR term.

Returnosid.assessment.AssessmentQueryan assessment query
ErrorsUNIMPLEMENTED supportsAssessmentQuery() is false
ComplianceoptionalThis method must be implemented if supportsAssessmentQuery() is true.
MethodmatchAnyAssessment
Description

Matches requisites that have any assessment requirement.

Parametersbooleanmatch true to match requisites with any assessment requirement, false to match requisites with no assessment requirements
CompliancemandatoryThis method must be implemented.
MethodclearAssessmentTerms
Description

Clears the assessment terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAwardId
Description

Sets the award Id for this query to match requisites that have a requirement for the given award.

Parametersosid.id.IdawardIdan award Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT awardId is null
CompliancemandatoryThis method must be implemented.
MethodclearAwardIdTerms
Description

Clears the award Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAwardQuery
Description

Tests if an AwardQuery is available.

Returnboolean true if an award query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAwardQuery
Description

Gets the query for a award requirement. Multiple retrievals produce a nested OR term.

Returnosid.recognition.AwardQueryan award query
ErrorsUNIMPLEMENTED supportsAwardQuery() is false
ComplianceoptionalThis method must be implemented if supportsAwardQuery() is true.
MethodmatchAnyAward
Description

Matches requisites that have any award requirement.

Parametersbooleanmatch true to match requisites with any award requirement, false to match requisites with no award requirements
CompliancemandatoryThis method must be implemented.
MethodclearAwardTerms
Description

Clears the award terms.

CompliancemandatoryThis method must be implemented.
MethodmatchContainingRequisiteId
Description

Sets the requisite Id for this query to match requisites that have the specified requisite as an ancestor.

Parametersosid.id.IdrequisiteIda requisite Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT requisiteId is null
CompliancemandatoryThis method must be implemented.
MethodclearContainingRequisiteIdTerms
Description

Clears the containing requisite Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsContainingRequisiteQuery
Description

Tests if a containing requisite query is available.

Returnboolean true if a containing requisite query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetContainingRequisiteQuery
Description

Gets the query for a containing requisite.

Returnosid.course.requisite.RequisiteQuerythe containing requisite query
ErrorsUNIMPLEMENTED supportsContainingRequisiteQuery() is false
ComplianceoptionalThis method must be implemented if supportsContainingRequisiteQuery() is true.
MethodmatchAnyContainingRequisite
Description

Matches requisites with any ancestor requisite.

Parametersbooleanmatch true to match requisites with any ancestor requisite, false to match requisites with no ancestor requisites
CompliancemandatoryThis method must be implemented.
MethodclearContainingRequisiteTerms
Description

Clears the containing requisite terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCourseCatalogId
Description

Sets the course catalog Id for this query to match requisites assigned to course catalogs.

Parametersosid.id.IdcourseCatalogIdthe course catalog Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT courseCatalogId is null
CompliancemandatoryThis method must be implemented.
MethodclearCourseCatalogIdTerms
Description

Clears the course catalog Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsCourseCatalogQuery
Description

Tests if a CourseCatalogQuery is available.

Returnboolean true if a course catalog query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalogQuery
Description

Gets the query for a course catalog. Multiple retrievals produce a nested OR term.

Returnosid.course.CourseCatalogQuerythe course catalog query
ErrorsUNIMPLEMENTED supportsCourseCatalogQuery() is false
ComplianceoptionalThis method must be implemented if supportsCourseCatalogQuery() is true.
MethodclearCourseCatalogTerms
Description

Clears the course catalog terms.

CompliancemandatoryThis method must be implemented.
MethodgetRequisiteQueryRecord
Description

Gets the requisite query record corresponding to the given Requisite record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TyperequisiteRecordTypea requisites record type
Returnosid.course.requisite.records.RequisiteQueryRecordthe requisite query record
ErrorsNULL_ARGUMENT requisiteRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(requisiteRecordType) is false
CompliancemandatoryThis method must be implemented.