OSID Logo
OSID Specifications
course plan package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.plan.PlanQuery
Implementsosid.OsidRelationshipQuery
Description

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

MethodmatchSyllabusId
Description

Sets the syllabus Id for this query.

Parametersosid.id.IdsyllabusIda syllabus Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT syllabusId is null
CompliancemandatoryThis method must be implemented.
MethodclearSyllabusIdTerms
Description

Clears the syllabus Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsSyllabusQuery
Description

Tests if a syllabus query is available.

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

Gets the query for a lesson.

Returnosid.course.syllabus.SyllabusQuerythe syllabus query
ErrorsUNIMPLEMENTED supportsSyllabusQuery() is false
ComplianceoptionalThis method must be implemented if supportsSyllabusQuery() is true.
MethodclearSyllabusTerms
Description

Clears the syllabus terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCourseOfferingId
Description

Sets the course offering Id for this query.

Parametersosid.id.IdcourseOfferingIda course offering Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT syllabusId is null
CompliancemandatoryThis method must be implemented.
MethodclearCourseOfferingIdTerms
Description

Clears the course offering Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsCourseOfferingQuery
Description

Tests if a course offering query is available.

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

Gets the query for a course offering.

Returnosid.course.CourseOfferingQuerythe course offering query
ErrorsUNIMPLEMENTED supportsCourseOfferingQuery() is false
ComplianceoptionalThis method must be implemented if supportsCourseOfferingQuery() is true.
MethodclearCourseOfferingTerms
Description

Clears the syllabus terms.

CompliancemandatoryThis method must be implemented.
MethodmatchModuleId
Description

Sets a module Id.

Parametersosid.id.IdmoduleIda module Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT moduleId is null
CompliancemandatoryThis method must be implemented.
MethodclearModuleIdTerms
Description

Clears the module Id terms.

CompliancemandatoryThis method must be implemented.
MethodgetModuleQuery
Description

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

Returnosid.course.syllabus.ModuleQuerythe lesson query
ErrorsUNIMPLEMENTED supportsModuleQuery() is false
ComplianceoptionalThis method must be implemented if supportsModuleQuery() is true.
MethodmatchAnyModule
Description

Matches plans with any module.

Parametersbooleanmatch true to match pans with any module, false to match plans with no modules
CompliancemandatoryThis method must be implemented.
MethodclearModuleTerms
Description

Clears the module terms.

CompliancemandatoryThis method must be implemented.
MethodmatchLessonId
Description

Sets a lesson Id.

Parametersosid.id.IdlessonIda lesson Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT lessonId is null
CompliancemandatoryThis method must be implemented.
MethodclearLessonIdTerms
Description

Clears the lesson Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsLessonQuery
Description

Tests if an LessonQuery is available.

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

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

Returnosid.course.plan.LessonQuerythe lesson query
ErrorsUNIMPLEMENTED supportsLessonQuery() is false
ComplianceoptionalThis method must be implemented if supportsLessonrQuery() is true.
MethodmatchAnyLesson
Description

Matches plans with any lesson.

Parametersbooleanmatch true to match covocations with any lesson, false to match plans with no lessons
CompliancemandatoryThis method must be implemented.
MethodclearLessonTerms
Description

Clears the lesson terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCourseCatalogId
Description

Sets the lesson Id for this query to match plans assigned to course catalogs.

Parametersosid.id.IdcourseCatalogIda 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 an 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 query. 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.
MethodgetPlanQueryRecord
Description

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

Parametersosid.type.TypeplanRecordTypea plan record type
Returnosid.course.plan.records.PlanQueryRecordthe plan query record
ErrorsNULL_ARGUMENT planRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(planRecordType) is false
CompliancemandatoryThis method must be implemented.