OSID - osid.course.plan.PlanQuery Service Interface Definition

Interface	osid.course.plan.PlanQuery
Implements	`osid.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.`
Method	matchSyllabusId
Description	Sets the syllabus `Id` for this query.
Parameters	`osid.id.Id`	`syllabusId`	a syllabus `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`syllabusId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearSyllabusIdTerms
Description	Clears the syllabus `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsSyllabusQuery
Description	Tests if a syllabus query is available.
Return	`boolean`		`true` if a syllabus query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSyllabusQuery
Description	Gets the query for a lesson.
Return	`osid.course.syllabus.SyllabusQuery`		the syllabus query
Errors	UNIMPLEMENTED		`supportsSyllabusQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSyllabusQuery()` is `true.`
Method	clearSyllabusTerms
Description	Clears the syllabus terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCourseOfferingId
Description	Sets the course offering `Id` for this query.
Parameters	`osid.id.Id`	`courseOfferingId`	a course offering `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`syllabusId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCourseOfferingIdTerms
Description	Clears the course offering `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseOfferingQuery
Description	Tests if a course offering query is available.
Return	`boolean`		`true` if a course offering query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCourseOfferingQuery
Description	Gets the query for a course offering.
Return	`osid.course.CourseOfferingQuery`		the course offering query
Errors	UNIMPLEMENTED		`supportsCourseOfferingQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCourseOfferingQuery()` is `true.`
Method	clearCourseOfferingTerms
Description	Clears the syllabus terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchModuleId
Description	Sets a module `Id.`
Parameters	`osid.id.Id`	`moduleId`	a module `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`moduleId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearModuleIdTerms
Description	Clears the module `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	getModuleQuery
Description	Gets the query for a module query. Multiple retrievals produce a nested `OR` term.
Return	`osid.course.syllabus.ModuleQuery`		the lesson query
Errors	UNIMPLEMENTED		`supportsModuleQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsModuleQuery()` is `true.`
Method	matchAnyModule
Description	Matches plans with any module.
Parameters	`boolean`	`match`	`true` to match pans with any module, `false` to match plans with no modules
Compliance	`mandatory`		This method must be implemented.
Method	clearModuleTerms
Description	Clears the module terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchLessonId
Description	Sets a lesson `Id.`
Parameters	`osid.id.Id`	`lessonId`	a lesson `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`lessonId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearLessonIdTerms
Description	Clears the lesson `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsLessonQuery
Description	Tests if an `LessonQuery` is available.
Return	`boolean`		`true` if a lesson query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getLessonQuery
Description	Gets the query for a lesson query. Multiple retrievals produce a nested `OR` term.
Return	`osid.course.plan.LessonQuery`		the lesson query
Errors	UNIMPLEMENTED		`supportsLessonQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLessonrQuery()` is `true.`
Method	matchAnyLesson
Description	Matches plans with any lesson.
Parameters	`boolean`	`match`	`true` to match covocations with any lesson, `false` to match plans with no lessons
Compliance	`mandatory`		This method must be implemented.
Method	clearLessonTerms
Description	Clears the lesson terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCourseCatalogId
Description	Sets the lesson `Id` for this query to match plans assigned to course catalogs.
Parameters	`osid.id.Id`	`courseCatalogId`	a course catalog `Id`
Parameters	`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 `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseCatalogQuery
Description	Tests if an `CourseCatalogQuery` is available.
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 query. Multiple retrievals produce a nested `OR` term.
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	getPlanQueryRecord
Description	Gets the plan query record corresponding to the given `Plan` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`planRecordType`	a plan record type
Return	`osid.course.plan.records.PlanQueryRecord`		the plan query record
Errors	NULL_ARGUMENT		`planRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(planRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.