OSID - osid.recipe.RecipeQuerySession Service Interface Definition

Interface	osid.recipe.RecipeQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.recipe.RecipeSearchSession`
Used By	`osid.recipe.RecipeManager`
Used By	`osid.recipe.RecipeProxyManager`
Description	This session provides methods for searching among `Recipe` objects. The search query is constructed using the `RecipeQuery` . This session defines views that offer differing behaviors for searching. federated cookbook view: searches include recipes in cookbooks of which this cookbook is an ancestor in the cookbook hierarchy isolated cookbook view: searches are restricted to recipes in this cookbooks Recipes may have a query record indicated by their respective record types. The query record is accessed via the `RecipeQuery` .
Method	getCookbookId
Description	Gets the `Cookbook` `Id` associated with this session.
Return	`osid.id.Id`		the `Cookbook Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCookbook
Description	Gets the `Cookbook` associated with this session.
Return	`osid.recipe.Cookbook`		the cookbook
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchRecipes
Description	Tests if this user can perform `Recipe` lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED` . This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedCookbookView
Description	Federates the view for methods in this session. A federated view will include recipes in cookbook which are children of this cookbook in the cookbook hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedCookbookView
Description	Isolates the view for methods in this session. An isolated view restricts searches to this cookbook only.
Compliance	`mandatory`		This method is must be implemented.
Method	getRecipeQuery
Description	Gets a recipe query.
Return	`osid.recipe.RecipeQuery`		the recipe query
Compliance	`mandatory`		This method must be implemented.
Method	getRecipesByQuery
Description	Gets a list of `Recipes` matching the given recipe query.
Parameters	`osid.recipe.RecipeQuery`	`recipeQuery`	the recipe query
Return	`osid.recipe.RecipeList`		the returned `RecipeList`
Errors	NULL_ARGUMENT		`recipeQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`recipeQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.