OSID - osid.recipe.ProcedureQuery Service Interface Definition

Interface	osid.recipe.ProcedureQuery
Implements	`osid.OsidObjectQuery`
Used By	`osid.recipe.CookbookQuery`
	`osid.recipe.DirectionQuery`
	`osid.recipe.ProcedureQuerySession`
	`osid.recipe.ProcedureSearchSession`
	`osid.recipe.ProcedureSmartCookbookSession`
Description	This is the query for searching procedures. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchLearningObjectiveId
Description	Sets the objective `Id` for this query.
Parameters	`osid.id.Id`	`objectiveId`	the asset `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` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsLearningObjectiveQuery
Description	Tests if an `ObjectiveQuery` is available.
Return	`boolean`		`true` if an objective 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 directions with any objective.
Parameters	`boolean`	`match`	`true` to match directions with any objective, `false` to match directions with no objectives
Compliance	`mandatory`		This method must be implemented.
Method	clearLearningObjectiveTerms
Description	Clears the objective query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCookbookId
Description	Sets the award `Id` for this query to match procedures assigned to cookbooks.
Parameters	`osid.id.Id`	`cookbookId`	a cookbook `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`cookbookId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCookbookIdTerms
Description	Clears the cookbook `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCookbookQuery
Description	Tests if an `CookbookQuery` is available.
Return	`boolean`		`true` if a cookbook query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCookbookQuery
Description	Gets the query for a cookbook query. Multiple retrievals produce a nested `OR` term.
Return	`osid.recipe.CookbookQuery`		the cookbook query
Errors	UNIMPLEMENTED		`supportsCookbookQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCookbookQuery()` is `true`.
Method	clearCookbookTerms
Description	Clears the cookbook terms.
Compliance	`mandatory`		This method must be implemented.
Method	getProcedureQueryRecord
Description	Gets the procedure query record corresponding to the given `Procedure` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`procedureRecordType`	a procedure record type
Return	`osid.recipe.records.ProcedureQueryRecord`		the procedure query record
Errors	NULL_ARGUMENT		`procedureRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(procedureRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.