Interface | osid.course.requisite.RequisiteQuery | ||
---|---|---|---|
Implements | osid.OsidRuleQuery | ||
osid.OsidEnablerQuery | |||
osid.OsidContainableQuery | |||
Description |
This is the query for searching requisites. Each method
match specifies an | ||
Method | matchRequisiteOptionId | ||
Description |
Sets the requisite | ||
Parameters | osid.id.Id | requisiteId | a requisite Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | requisiteId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearRequisiteOptionIdTerms | ||
Description |
Clears the requisite | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsRequisiteOptionQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a requisite query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRequisiteOptionQuery | ||
Description |
Gets the query for a requisite option. Multiple
retrievals produce a nested | ||
Return | osid.course.requisite.RequisiteQuery | a requisite query | |
Errors | UNIMPLEMENTED | supportsRequisiteOptionQuery() is false | |
Compliance | optional | This method must be implemented if supportsRequisiteOptionQuery()
is true. | |
Method | matchAnyRequisiteOption | ||
Description |
Matches requisites that have any requisite option. | ||
Parameters | boolean | match | true to match requisites with any requisite option,
false to match requisites with no requisite options |
Compliance | mandatory | This method must be implemented. | |
Method | clearRequisiteOptionTerms | ||
Description |
Clears the requisite option terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchCourseId | ||
Description |
Sets the course | ||
Parameters | osid.id.Id | courseId | a course Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | courseId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearCourseIdTerms | ||
Description |
Clears the course | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsCourseQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a course query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCourseQuery | ||
Description |
Gets the query for a course requirement. Multiple
retrievals produce a nested | ||
Return | osid.course.CourseQuery | a course query | |
Errors | UNIMPLEMENTED | supportsCourseQuery() is false | |
Compliance | optional | This method must be implemented if supportsCourseQuery() is
true. | |
Method | matchAnyCourse | ||
Description |
Matches requisites that have any course requirement. | ||
Parameters | boolean | match | true to match requisites with any course requirement,
false to match requisites with no course requirements |
Compliance | mandatory | This method must be implemented. | |
Method | clearCourseTerms | ||
Description |
Clears the course terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchProgramId | ||
Description |
Sets the program | ||
Parameters | osid.id.Id | programId | a program Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | programId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearProgramIdTerms | ||
Description |
Clears the program | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsProgramQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a program query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getProgramQuery | ||
Description |
Gets the query for a program requirement. Multiple
retrievals produce a nested | ||
Return | osid.course.program.ProgramQuery | a program query | |
Errors | UNIMPLEMENTED | supportsProgramQuery() is false | |
Compliance | optional | This method must be implemented if supportsProgramQuery() is
true. | |
Method | matchAnyProgram | ||
Description |
Matches requisites that have any program requirement. | ||
Parameters | boolean | match | true to match requisites with any program requirement,
false to match requisites with no program requirements |
Compliance | mandatory | This method must be implemented. | |
Method | clearProgramTerms | ||
Description |
Clears the program terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchCredentialId | ||
Description |
Sets the credential | ||
Parameters | osid.id.Id | credentialId | a credential Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | credentialId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearCredentialIdTerms | ||
Description |
Clears the credential | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsCredentialQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a credential query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCredentialQuery | ||
Description |
Gets the query for a credential requirement. Multiple
retrievals produce a nested | ||
Return | osid.course.program.CredentialQuery | a credential query | |
Errors | UNIMPLEMENTED | supportsCredentialQuery() is false | |
Compliance | optional | This method must be implemented if supportsCredentialQuery()
is true. | |
Method | matchAnyCredential | ||
Description |
Matches requisites that have any credential requirement. | ||
Parameters | boolean | match | true to match requisites with any credential requirement,
false to match requisites with no credential requirements |
Compliance | mandatory | This method must be implemented. | |
Method | clearCredentialTerms | ||
Description |
Clears the credential terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchLearningObjectiveId | ||
Description |
Sets the learning objective | ||
Parameters | osid.id.Id | objectiveId | a learning objective Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | objectiveId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearLearningObjectiveIdTerms | ||
Description |
Clears the learning objective | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsLearningObjectiveQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a learning objective query is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getLearningObjectiveQuery | ||
Description |
Gets the query for a learning objective requirement.
Multiple retrievals produce a nested | ||
Return | osid.learning.ObjectiveQuery | a learning objective query | |
Errors | UNIMPLEMENTED | supportsLearningObjectiveQuery() is false | |
Compliance | optional | This method must be implemented if supportsLearningObjectiveQuery()
is true. | |
Method | matchAnyLearningObjective | ||
Description |
Matches requisites that have any learning objective requirement. | ||
Parameters | boolean | match | true to match requisites with any learning objective
requirement, false to match requisites with no learning
objective requirements |
Compliance | mandatory | This method must be implemented. | |
Method | clearLearningObjectiveTerms | ||
Description |
Clears the learning objective terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAssessmentId | ||
Description |
Sets the assessment | ||
Parameters | osid.id.Id | assessmentId | an assessment Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | assessmentId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearAssessmentIdTerms | ||
Description |
Clears the assessment | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsAssessmentQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an assessment query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAssessmentQuery | ||
Description |
Gets the query for a assessment requirement. Multiple
retrievals produce a nested | ||
Return | osid.assessment.AssessmentQuery | an assessment query | |
Errors | UNIMPLEMENTED | supportsAssessmentQuery() is false | |
Compliance | optional | This method must be implemented if supportsAssessmentQuery()
is true. | |
Method | matchAnyAssessment | ||
Description |
Matches requisites that have any assessment requirement. | ||
Parameters | boolean | match | true to match requisites with any assessment requirement,
false to match requisites with no assessment requirements |
Compliance | mandatory | This method must be implemented. | |
Method | clearAssessmentTerms | ||
Description |
Clears the assessment terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAwardId | ||
Description |
Sets the award | ||
Parameters | osid.id.Id | awardId | an award Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | awardId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearAwardIdTerms | ||
Description |
Clears the award | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsAwardQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an award query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAwardQuery | ||
Description |
Gets the query for a award requirement. Multiple
retrievals produce a nested | ||
Return | osid.recognition.AwardQuery | an award query | |
Errors | UNIMPLEMENTED | supportsAwardQuery() is false | |
Compliance | optional | This method must be implemented if supportsAwardQuery() is
true. | |
Method | matchAnyAward | ||
Description |
Matches requisites that have any award requirement. | ||
Parameters | boolean | match | true to match requisites with any award requirement,
false to match requisites with no award requirements |
Compliance | mandatory | This method must be implemented. | |
Method | clearAwardTerms | ||
Description |
Clears the award terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchContainingRequisiteId | ||
Description |
Sets the requisite | ||
Parameters | osid.id.Id | requisiteId | a requisite Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | requisiteId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearContainingRequisiteIdTerms | ||
Description |
Clears the containing requisite | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsContainingRequisiteQuery | ||
Description |
Tests if a containing requisite query is available. | ||
Return | boolean | true if a containing requisite query is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getContainingRequisiteQuery | ||
Description |
Gets the query for a containing requisite. | ||
Return | osid.course.requisite.RequisiteQuery | the containing requisite query | |
Errors | UNIMPLEMENTED | supportsContainingRequisiteQuery() is false | |
Compliance | optional | This method must be implemented if
supportsContainingRequisiteQuery() is true. | |
Method | matchAnyContainingRequisite | ||
Description |
Matches requisites with any ancestor requisite. | ||
Parameters | boolean | match | true to match requisites with any ancestor requisite,
false to match requisites with no ancestor requisites |
Compliance | mandatory | This method must be implemented. | |
Method | clearContainingRequisiteTerms | ||
Description |
Clears the containing requisite terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchCourseCatalogId | ||
Description |
Sets the course catalog | ||
Parameters | osid.id.Id | courseCatalogId | the course catalog Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | courseCatalogId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearCourseCatalogIdTerms | ||
Description |
Clears the course catalog | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsCourseCatalogQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a course catalog query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCourseCatalogQuery | ||
Description |
Gets the query for a course catalog. Multiple
retrievals produce a nested | ||
Return | osid.course.CourseCatalogQuery | the course catalog query | |
Errors | UNIMPLEMENTED | supportsCourseCatalogQuery() is false | |
Compliance | optional | This method must be implemented if supportsCourseCatalogQuery()
is true. | |
Method | clearCourseCatalogTerms | ||
Description |
Clears the course catalog terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRequisiteQueryRecord | ||
Description |
Gets the requisite query record corresponding to the
given | ||
Parameters | osid.type.Type | requisiteRecordType | a requisites record type |
Return | osid.course.requisite.records.RequisiteQueryRecord | the requisite query 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. |