OSID - osid.recipe.DirectionSearchSession Service Interface Definition

Interface	osid.recipe.DirectionSearchSession
Implements	`osid.recipe.DirectionQuerySession`
Used By	`osid.recipe.RecipeManager`
Used By	`osid.recipe.RecipeProxyManager`
Description	This session provides methods for searching among `Direction` objects. The search query is constructed using the `DirectionQuery` . `getDirectionsByQuery()` is the basic search method and returns a list of `Directions` . A more advanced search may be performed with `getDirectionsBySearch()` .It accepts a `DirectionSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getDirectionsBySearch()` returns a `DirectionSearchResults` that can be used to access the resulting `DirectionList` or be used to perform a search within the result set through `DirectionSearch` . This session defines views that offer differing behaviors for searching. federated cookbook view: searches include directions in cookbooks of which this cookbook is an ancestor in the cookbook hierarchy isolated cookbook view: searches are restricted to directions in this cookbooks Directions may have a query record indicated by their respective record types. The query record is accessed via the `DirectionQuery` .
Method	getDirectionSearch
Description	Gets a direction search.
Return	`osid.recipe.DirectionSearch`		the direction search
Compliance	`mandatory`		This method must be implemented.
Method	getDirectionSearchOrder
Description	Gets a direction search order. The `DirectionSearchOrder` is supplied to a `DirectionSearch` to specify the ordering of results.
Return	`osid.recipe.DirectionSearchOrder`		the direction search order
Compliance	`mandatory`		This method must be implemented.
Method	getDirectionsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.recipe.DirectionQuery`	`directionQuery`	the direction query
Parameters	`osid.recipe.DirectionSearch`	`directionSearch`	the direction search
Return	`osid.recipe.DirectionSearchResults`		the direction search results
Errors	NULL_ARGUMENT		`directionQuery` or `directionSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`directionQuery` or `directionSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getDirectionQueryFromInspector
Description	Gets a direction query. from an inspector. The inspector is available from a `DirectionSearchResults` .
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.