OSID - osid.recipe.RecipeSmartCookbookSession Service Interface Definition

Interface	osid.recipe.RecipeSmartCookbookSession
Implements	`osid.OsidSession`
Used By	`osid.recipe.RecipeManager`
Used By	`osid.recipe.RecipeProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `RecipeQuery` can be retrieved from this session and mapped to this `Cookbook` to create a virtual collection of `Recipes`. The recipes may be sequenced using the `RecipeSearchOrder` from this session. This `Cookbook` has a default query that matches any recipe and a default search order that specifies no sequencing. The queries may be examined using a `RecipeQueryInspector`. The query may be modified by converting the inspector back to a `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	canManageSmartCookbooks
Description	Tests if this user can manage smart cookbooks. A return of true does not guarantee successful authorization. A return of false indicates that it is known methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer operations to unauthorized users.
Return	`boolean`		`false` if smart cookbook management is not authorized, `true` otherwise
Compliance	`mandatory`		This method 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	getRecipeSearchOrder
Description	Gets a recipe search order.
Return	`osid.recipe.RecipeSearchOrder`		the recipe search order
Compliance	`mandatory`		This method must be implemented.
Method	applyRecipeQuery
Description	Applies a recipe query to this cookbook.
Parameters	`osid.recipe.RecipeQuery`	`recipeQuery`	the recipe query
Errors	NULL_ARGUMENT		`recipeQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`recipeQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectRecipeQuery
Description	Gets a recipe query inspector for this cookbook.
Return	`osid.recipe.RecipeQueryInspector`		the recipe query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyRecipeSequencing
Description	Applies a recipe search order to this cookbook.
Parameters	`osid.recipe.RecipeSearchOrder`	`recipeSearchOrder`	the recipe search order
Errors	NULL_ARGUMENT		`recipeSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`recipeSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getRecipeQueryFromInspector
Description	Gets a recipe query from an inspector.
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.