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

Interface	osid.course.syllabus.ModuleQuery
Implements	`osid.OsidObjectQuery`
Implements	`osid.OsidSubjugateableQuery`
Used By	`osid.course.plan.PlanQuery`
	`osid.course.syllabus.DocetQuery`
	`osid.course.syllabus.ModuleQuerySession`
	`osid.course.syllabus.ModuleSearchSession`
	`osid.course.syllabus.ModuleSmartCourseCatalogSession`
	`osid.course.syllabus.SyllabusQuery`
Description	This is the query for searching modules. 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 docet.
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	matchDocetId
Description	Sets a docet `Id`.
Parameters	`osid.id.Id`	`docetId`	a docet `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`docetId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDocetIdTerms
Description	Clears the docet `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDocetQuery
Description	Tests if an `DocetQuery` is available.
Return	`boolean`		`true` if a docet query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDocetQuery
Description	Gets the query for a docet query. Multiple retrievals produce a nested `OR` term.
Return	`osid.course.syllabus.DocetQuery`		the docet query
Errors	UNIMPLEMENTED		`supportsDocetQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDocetQuery()` is `true`.
Method	matchAnyDocet
Description	Matches modules with any docet.
Parameters	`boolean`	`match`	`true` to match modules with any docet, `false` to match modules with no docets
Compliance	`mandatory`		This method must be implemented.
Method	clearDocetTerms
Description	Clears the docet terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCourseCatalogId
Description	Sets the docet `Id` for this query to match modules 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	getModuleQueryRecord
Description	Gets the module query record corresponding to the given `Module` record `Type` .Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`moduleRecordType`	a module record type
Return	`osid.course.syllabus.records.ModuleQueryRecord`		the module query record
Errors	NULL_ARGUMENT		`moduleRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(moduleRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.