OSID - osid.recipe.RecipeSearchSession Service Interface Definition

Interface	osid.recipe.RecipeSearchSession
Implements	`osid.recipe.RecipeQuerySession`
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` . `getRecipesByQuery()` is the basic search method and returns a list of `Recipes` . A more advanced search may be performed with `getRecipesBySearch()` .It accepts a `RecipeSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getRecipesBySearch()` returns a `RecipeSearchResults` that can be used to access the resulting `RecipeList` or be used to perform a search within the result set through `RecipeSearch` . 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	getRecipeSearch
Description	Gets a recipe search.
Return	`osid.recipe.RecipeSearch`		the recipe search
Compliance	`mandatory`		This method must be implemented.
Method	getRecipeSearchOrder
Description	Gets a recipe search order. The `RecipeSearchOrder` is supplied to a `RecipeSearch` to specify the ordering of results.
Return	`osid.recipe.RecipeSearchOrder`		the recipe search order
Compliance	`mandatory`		This method must be implemented.
Method	getRecipesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.recipe.RecipeQuery`	`recipeQuery`	the recipe query
Parameters	`osid.recipe.RecipeSearch`	`recipeSearch`	the recipe search
Return	`osid.recipe.RecipeSearchResults`		the recipe search results
Errors	NULL_ARGUMENT		`recipeQuery` or `recipeSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`recipeQuery` or `recipeSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getRecipeQueryFromInspector
Description	Gets a recipe query from an inspector. The inspector is available from a `RecipeSearchResults` .
Parameters	`osid.recipe.RecipeQueryInspector`	`recipeQueryInspector`	a recipe query inspector
Return	`osid.recipe.RecipeQuery`		the recipe query
Errors	NULL_ARGUMENT		`recipeQueryInspector` is `null`
Errors	UNSUPPORTED		`recipeQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.