OSID - osid.recipe.CookbookSearchSession Service Interface Definition

Interface	osid.recipe.CookbookSearchSession
Implements	`osid.recipe.CookbookQuerySession`
Used By	`osid.recipe.RecipeManager`
Used By	`osid.recipe.RecipeProxyManager`
Description	This session provides methods for searching `Cookbook` objects. The search query is constructed using the `CookbookQuery` . The cookbook record `Type` also specifies the record for the cookbook query. `getCookbooksByQuery()` is the basic search method and returns a list of `Cookbook` elements. A more advanced search may be performed with `getCookbooksBySearch()` .It accepts an `CookbookSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getCookbooksBySearch()` returns an `CookbookSearchResults` that can be used to access the resulting `CookbookList` or be used to perform a search within the result set through `CookbookSearch` . Cookbooks may have a query record indicated by their respective record types. The query record is accessed via the `CookbookQuery` . The returns in this session may not be cast directly to these interfaces.
Method	getCookbookSearch
Description	Gets a cookbook search.
Return	`osid.recipe.CookbookSearch`		the cookbook search
Compliance	`mandatory`		This method must be implemented.
Method	getCookbookSearchOrder
Description	Gets a cookbook search order. The `CookbookSearchOrder` is supplied to an `CookbookSearch` to specify the ordering of results.
Return	`osid.recipe.CookbookSearchOrder`		the cookbook search order
Compliance	`mandatory`		This method must be implemented.
Method	getCookbooksBySearch
Description	Gets the search results matching the given search.
Parameters	`osid.recipe.CookbookQuery`	`cookbookQuery`	the cookbook query
Parameters	`osid.recipe.CookbookSearch`	`cookbookSearch`	the cookbook search
Return	`osid.recipe.CookbookSearchResults`		the cookbook search results
Errors	NULL_ARGUMENT		`cookbookQuery` or `cookbooksearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`cookbookQuery` or `cookbooksearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCookbookQueryFromInspector
Description	Gets a cookbook query from an inspector. The inspector is available from an `CookbookSearchResults` .
Parameters	`osid.recipe.CookbookQueryInspector`	`cookbookQueryInspector`	a cookbook query inspector
Return	`osid.recipe.CookbookQuery`		the cookbook query
Errors	NULL_ARGUMENT		`cookbookQueryInspector` is `null`
Errors	UNSUPPORTED		`cookbookQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.