OSID - osid.recipe.ProcedureSmartCookbookSession Service Interface Definition

Interface	osid.recipe.ProcedureSmartCookbookSession
Implements	`osid.OsidSession`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `ProcedureQuery` can be retrieved from this session and mapped to this `Cookbook` to create a virtual collection of `Procedures.` The awards may be sequenced using the `ProcedureSearchOrder` from this session. This `Cookbook` has a default query that matches any procedure and a default search order that specifies no sequencing. The queries may be examined using a `ProcedureQueryInspector.` The query may be modified by converting the inspector back to a `ProcedureQuery.`
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` associated with this session
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 cook books. 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 cook book management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProcedureQuery
Description	Gets a procedure query.
Return	`osid.recipe.ProcedureQuery`		the procedure query
Compliance	`mandatory`		This method must be implemented.
Method	getProcedureSearchOrder
Description	Gets a procedure search order.
Return	`osid.recipe.ProcedureSearchOrder`		the procedure search order
Compliance	`mandatory`		This method must be implemented.
Method	applyProcedureQuery
Description	Applies a procedure query to this cookbook.
Parameters	`osid.recipe.ProcedureQuery`	`procedureQuery`	the procedure query
Errors	NULL_ARGUMENT		`procedureQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`procedureQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectProcedureQuery
Description	Gets a procedure query inspector for this cookbook.
Return	`osid.recipe.ProcedureQueryInspector`		the procedure query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyProcedureSequencing
Description	Applies a procedure search order to this cookbook.
Parameters	`osid.recipe.ProcedureSearchOrder`	`procedureSearchOrder`	the procedure search order
Errors	NULL_ARGUMENT		`procedureSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`procedureSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getProcedureQueryFromInspector
Description	Gets a procedure query from an inspector.
Parameters	`osid.recipe.ProcedureQueryInspector`	`procedureQueryInspector`	a query inspector
Return	`osid.recipe.ProcedureQuery`		the procedure query
Errors	NULL_ARGUMENT		`procedureQueryInspector` is `null`
Errors	UNSUPPORTED		`procedureQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.