OSID - osid.course.syllabus.SyllabusQuery Service Interface Definition

Interface	osid.course.syllabus.SyllabusQuery
Implements	`osid.OsidObjectQuery`
Implements	`osid.OsidSubjugateableQuery`
Used By	`osid.course.plan.PlanQuery`
	`osid.course.syllabus.ModuleQuery`
	`osid.course.syllabus.SyllabusQuerySession`
	`osid.course.syllabus.SyllabusSearchSession`
	`osid.course.syllabus.SyllabusSmartCourseCatalogSession`
Description	This is the query for searching syllaibi. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR` .
Method	matchCourseId
Description	Sets a course `Id` .
Parameters	`osid.id.Id`	`courseId`	a curse `Id`
Parameters	`boolean`	`match`	`true` for 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 `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseQuery
Description	Tests if a `CourseQuery` is available.
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 query. Multiple retrievals produce a nested `OR` term.
Return	`osid.course.CourseQuery`		the course query
Errors	UNIMPLEMENTED		`supportsCourseQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCourseQuery()` is `true` .
Method	clearCourseTerms
Description	Clears the course 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	supportsModuleQuery
Description	Tests if a `ModuleQuery` is available.
Return	`boolean`		`true` if a module query is available, `false` otherwise
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 module query
Errors	UNIMPLEMENTED		`supportsModuleQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsModuleQuery()` is `true` .
Method	matchAnyModule
Description	Matches any module.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearModuleTerms
Description	Clears the module terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCourseCatalogId
Description	Sets the docet `Id` for this query to match syllabi 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	getSyllabusQueryRecord
Description	Gets the syllabus query record corresponding to the given `Syllabus` record `Type` .Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`syllabusRecordType`	a syllabus record type
Return	`osid.course.syllabus.records.SyllabusQueryRecord`		the syllabus query record
Errors	NULL_ARGUMENT		`syllabusRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(syllabusRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.