OSID - osid.recipe.ProcedureQuerySession Service Interface Definition

Interface	osid.recipe.ProcedureQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.recipe.ProcedureSearchSession`
Used By	`osid.recipe.RecipeManager`
Used By	`osid.recipe.RecipeProxyManager`
Description	This session provides methods for searching `Procedure` objects. The search query is constructed using the `ProcedureQuery`. The procedure record `Type` also specifies the record for the award query. Procedures may have a query record indicated by their respective record types. The query record is accessed via the `ProcedureQuery`. The returns in this session may not be cast directly to these interfaces.
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	canSearchProcedures
Description	Tests if this user can perform susbcription searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may not wish to offer search operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedCookbookView
Description	Federates the view for methods in this session. A federated view will include procedures in cookbooks which are children of this cookbook in the cookbook hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedCookbookView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this cookbook only.
Compliance	`mandatory`		This method is 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	getProceduresByQuery
Description	Gets a list of procedures matching the given procedure query.
Parameters	`osid.recipe.ProcedureQuery`	`procedureQuery`	the procedure query
Return	`osid.recipe.ProcedureList`		the returned `ProcedureList`
Errors	NULL_ARGUMENT		`procedureQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`procedureQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.