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

Interface	osid.course.syllabus.DocetQuery
Implements	`osid.OsidRelationshipQuery`
Description	This is the query for searching for docets. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchModuleId
Description	Sets the module `Id` for this query.
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 module query 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.
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	clearModuleTerms
Description	Clears the module terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchActivityUnitId
Description	Sets the activity unit `Id` for this query.
Parameters	`osid.id.Id`	`activityUnitId`	an activity unit `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`activityUnitId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearActivityUnitIdTerms
Description	Clears the activity unit `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityUnitQuery
Description	Tests if an activity unit query is available.
Return	`boolean`		`true` if an activity unit query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getActivityUnitQuery
Description	Gets the query for an activity unit.
Return	`osid.course.ActivityUnitQuery`		the activity unit query
Errors	UNIMPLEMENTED		`supportsActivityUnitQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsActivityUnitQuery()` is `true.`
Method	clearActivityUnitTerms
Description	Clears the activity unit terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchLearningObjectiveId
Description	Sets the objective `Id` for this query.
Parameters	`osid.id.Id`	`objectiveId`	an objective `Id`
Parameters	`boolean`	`match`	`true` for 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 objective `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsLearningObjectiveQuery
Description	Tests if an `ObjectiveQuery` is available for querying objectives.
Return	`boolean`		`true` if an robjective query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getLearningObjectiveQuery
Description	Gets the query for an objective. Multiple retrievals produce a nested `OR` term.
Return	`osid.learning.ObjectiveQuery`		the objective query
Errors	UNIMPLEMENTED		`supportsLearningObjectiveQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLearningObjectiveQuery()` is `true.`
Method	matchAnyLearningObjective
Description	Matches a docet that has any objective assigned.
Parameters	`boolean`	`match`	`true` to match docets with any objective, `false` to match docets with no objective
Compliance	`mandatory`		This method must be implemented.
Method	clearLearningObjectiveTerms
Description	Clears the objective terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchInClass
Description	Matches docets that occur in a class.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`assetId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearInClassTerms
Description	Clears the in class terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDuration
Description	Matches durations between the given durations inclusive.
Parameters	`osid.calendaring.Duration`	`from`	starting duration
	`osid.calendaring.Duration`	`to`	ending duration
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyDuration
Description	Matches a docet that has any duration assigned.
Parameters	`boolean`	`match`	`true` to match docets with any duration, `false` to match docets with no duration
Compliance	`mandatory`		This method must be implemented.
Method	clearDurationTerms
Description	Clears the duration terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAssetId
Description	Sets the asset `Id` for this query.
Parameters	`osid.id.Id`	`assetId`	an asset `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`assetId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAssetIdTerms
Description	Clears the asset `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssetQuery
Description	Tests if an `AssetQuery` is available.
Return	`boolean`		`true` if an robjective query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAssetQuery
Description	Gets the query for an asset. Multiple retrievals produce a nested `OR` term.
Return	`osid.repository.AssetQuery`		the asset query
Errors	UNIMPLEMENTED		`supportsAssetQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsObjectiveQuery()` is `true.`
Method	matchAnyAsset
Description	Matches a docet that has any asset assigned.
Parameters	`boolean`	`match`	`true` to match docets with any asset, `false` to match docets with no asset
Compliance	`mandatory`		This method must be implemented.
Method	clearAssetTerms
Description	Clears the asset terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAssessmentId
Description	Sets the assessment `Id` for this query.
Parameters	`osid.id.Id`	`assessmentId`	an assessment `Id`
Parameters	`boolean`	`match`	`true` for 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 `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssessmentQuery
Description	Tests if an `AssessmentQuery` is available.
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 an assessment. Multiple retrievals produce a nested `OR` term.
Return	`osid.assessment.AssessmentQuery`		the assessment query
Errors	UNIMPLEMENTED		`supportsAssessmentQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAssessmentQuery()` is `true.`
Method	matchAnyAssessment
Description	Matches an objective that has any assessment assigned.
Parameters	`boolean`	`match`	`true` to match docets with any assessment, `false` to match docets with no assessment
Compliance	`mandatory`		This method must be implemented.
Method	clearAssessmentTerms
Description	Clears the assessment 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	getDocetQueryRecord
Description	Gets the docet query record corresponding to the given `Docet` record `Type.` Multiple record retrievals produce a nested boolean `OR` term.
Parameters	`osid.type.Type`	`docetRecordType`	a docet record type
Return	`osid.course.syllabus.records.DocetQueryRecord`		the docet query record
Errors	NULL_ARGUMENT		`docetRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(docetRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.