OSID - osid.recipe.DirectionSmartCookbookSession Service Interface Definition

Interface	osid.recipe.DirectionSmartCookbookSession
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 `DirectionQuery` can be retrieved from this session and assigned to this `Cookbook` to create a virtual collection of `Directions`. The directions may be sequenced using the `DirectionSearchOrder` from this session. This `Cookbook` has a default query that matches any direction and a default search order that specifies no sequencing. The queries may be examined using a `DirectionQueryInspector`. The query may be modified by converting the inspector back to a `DirectionQuery`.
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	canManageSmartOubiliettes
Description	Tests if this user can manage smart oubiliettes. 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	getDirectionQuery
Description	Gets a direction query.
Return	`osid.recipe.DirectionQuery`		the direction query
Compliance	`mandatory`		This method must be implemented.
Method	getDirectionSearchOrder
Description	Gets a direction search order.
Return	`osid.recipe.DirectionSearchOrder`		the direction search order
Compliance	`mandatory`		This method must be implemented.
Method	applyDirectionQuery
Description	Applies a direction query to this cookbook.
Parameters	`osid.recipe.DirectionQuery`	`directionQuery`	the direction query
Errors	NULL_ARGUMENT		`directionQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`directionQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspecDirectionQuery
Description	Gets a direction query inspector for this cookbook.
Return	`osid.recipe.DirectionQueryInspector`		the direction query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyDirectionSequencing
Description	Applies a direction search order to this cookbook.
Parameters	`osid.recipe.DirectionSearchOrder`	`directionSearchOrder`	the direction search order
Errors	NULL_ARGUMENT		`directionSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`directionSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getDirectionQueryFromInspector
Description	Gets a direction query from an inspector.
Parameters	`osid.recipe.DirectionQueryInspector`	`directionQueryInspector`	a direction query inspector
Return	`osid.recipe.DirectionQuery`		the direction query
Errors	NULL_ARGUMENT		`directionQueryInspector` is `null`
Errors	UNSUPPORTED		`directionQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.