OSID - osid.recipe.CookbookQuery Service Interface Definition

Interface	osid.recipe.CookbookQuery
Implements	`osid.OsidCatalogQuery`
Used By	`osid.recipe.CookbookQuery`
	`osid.recipe.CookbookQuerySession`
	`osid.recipe.CookbookSearchSession`
	`osid.recipe.DirectionQuery`
	`osid.recipe.ProcedureQuery`
	`osid.recipe.RecipeQuery`
Description	This is the query for searching for cookbooks. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRecipeId
Description	Sets the recipe `Id` for this query.
Parameters	`osid.id.Id`	`recipeId`	a recipe `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`recipeId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRecipeIdTerms
Description	Clears the recipe `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRecipeQuery
Description	Tests if a recipe query is available.
Return	`boolean`		`true` if a recipe query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRecipeQuery
Description	Gets the query for a recipe.
Return	`osid.recipe.RecipeQuery`		the recipe query
Errors	UNIMPLEMENTED		`supportsRecipeQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRecipeQuery()` is `true`.
Method	matchAnyRecipe
Description	Matches cookbooks with any recipe.
Parameters	`boolean`	`match`	`true` to match cookbooks with any recipe, `false` to match cookbooks with no recipes
Compliance	`mandatory`		This method must be implemented.
Method	clearRecipeTerms
Description	Clears the procedure terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchProcedureId
Description	Sets the procedure `Id` for this query to match procedures assigned to cookbooks.
Parameters	`osid.id.Id`	`procedureId`	a procedure `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`procedureId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearProcedureIdTerms
Description	Clears the procedure `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsProcedureQuery
Description	Tests if a procedure query is available.
Return	`boolean`		`true` if a procedure query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProcedureQuery
Description	Gets the query for a procedure.
Return	`osid.recipe.ProcedureQuery`		the procedure query
Errors	UNIMPLEMENTED		`supportsProcedureQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProcedureQuery()` is `true`.
Method	matchAnyProcedure
Description	Matches cookbooks with any procedure.
Parameters	`boolean`	`match`	`true` to match cookbooks with any procedure, `false` to match cookbooks with no procedures
Compliance	`mandatory`		This method must be implemented.
Method	clearProcedureTerms
Description	Clears the procedure terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDirectionId
Description	Sets a direction `Id`.
Parameters	`osid.id.Id`	`directionId`	a direction `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`directionId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDirectionIdTerms
Description	Clears the direction `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDirectionQuery
Description	Tests if a `DirectionQuery` is available.
Return	`boolean`		`true` if a direction query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDirectionQuery
Description	Gets the query for a direction query. Multiple retrievals produce a nested `OR` term.
Return	`osid.recipe.DirectionQuery`		the direction query
Errors	UNIMPLEMENTED		`supportsDirectionQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDirectionQuery()` is `true`.
Method	matchAnyDirection
Description	Matches any direction.
Parameters	`boolean`	`match`	`true` to match cookbooks with any direction, `false` to match cookbooks with no directions
Compliance	`mandatory`		This method must be implemented.
Method	clearDirectionTerms
Description	Clears the direction terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAncestorCookbookId
Description	Sets the cookbook `Id` for this query to match cookbooks that have the specified cookbook as an ancestor.
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	clearAncestorCookbookIdTerms
Description	Clears the ancestor cookbook `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorCookbookQuery
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	getAncestorCookbookQuery
Description	Gets the query for a cookbook. Multiple retrievals produce a nested `OR` term.
Return	`osid.recipe.CookbookQuery`		the cookbook query
Errors	UNIMPLEMENTED		`supportsAncestorCookbookQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorCookbookQuery()` is `true`.
Method	matchAnyAncestorCookbook
Description	Matches cookbooks with any ancestor.
Parameters	`boolean`	`match`	`true` to match cookbooks with any ancestor, `false` to match root cookbooks
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorCookbookTerms
Description	Clears the ancestor cookbook terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantCookbookId
Description	Sets the cookbook `Id` for this query to match cookbooks that have the specified cookbook as a descendant.
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	clearDescendantCookbookIdTerms
Description	Clears the descendant coo book `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantCookbookQuery
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	getDescendantCookbookQuery
Description	Gets the query for a cookbook. Multiple retrievals produce a nested `OR` term.
Return	`osid.recipe.CookbookQuery`		the cookbook query
Errors	UNIMPLEMENTED		`supportsDescendantCookbookQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantCookbookQuery()` is `true`.
Method	matchAnyDescendantCookbook
Description	Matches cookbooks with any descendant.
Parameters	`boolean`	`match`	`true` to match cookbooks with any descendant, `false` to match leaf cookbooks
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantCookbookTerms
Description	Clears the descendant cookbook terms.
Compliance	`mandatory`		This method must be implemented.
Method	getCookbookQueryRecord
Description	Gets the query record corresponding to the given `Cookbook` record `Type`. Multiple record retrievals produce a nested boolean `OR` term.
Parameters	`osid.type.Type`	`cookbookRecordType`	a cookbook record type
Return	`osid.recipe.records.CookbookQueryRecord`		the cookbook query record
Errors	NULL_ARGUMENT		`cookbookRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(cookbookRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.