OSID - osid.recipe.ProcedureSearchSession Service Interface Definition

Interface	osid.recipe.ProcedureSearchSession
Implements	`osid.recipe.ProcedureQuerySession`
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 procedure query. `getProceduresByQuery()` is the basic search method and returns a list of `Cookbook` elements. A more advanced search may be performed with `getProceduresBySearch()` . It accepts a `ProcedureSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getProceduresBySearch()` returns a `ProcedureSearchResults` that can be used to access the resulting `ProcedureList` or be used to perform a search within the result set through `ProcedureSearch` . 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	getProcedureSearch
Description	Gets a procedure search.
Return	`osid.recipe.ProcedureSearch`		the procedure search
Compliance	`mandatory`		This method must be implemented.
Method	getProcedureSearchOrder
Description	Gets a procedure search order. The `ProcedureSearchOrder` is supplied to a `ProcedureSearch` to specify the ordering of results.
Return	`osid.recipe.ProcedureSearchOrder`		the procedure search order interface
Compliance	`mandatory`		This method must be implemented.
Method	getProceduresBySearch
Description	Gets the search results matching the given search.
Parameters	`osid.recipe.ProcedureQuery`	`procedureQuery`	the procedure query
Parameters	`osid.recipe.ProcedureSearch`	`procedureSearch`	the procedure search
Return	`osid.recipe.ProcedureSearchResults`		the procedure search results
Errors	NULL_ARGUMENT		`procedureQuery` or `procedureSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`procedureQuery` or `procedureSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getProcedureQueryFromInspector
Description	Gets a procedure query from an inspector. The inspector is available from a `ProcedureSearchResults` .
Parameters	`osid.recipe.ProcedureQueryInspector`	`procedureQueryInspector`	a procedure 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.