OSID - osid.inventory.StockSearchSession Service Interface Definition

Interface	osid.inventory.StockSearchSession
Implements	`osid.inventory.StockQuerySession`
Description	This session provides methods for searching among `Stock` objects. The search query is constructed using the `StockQuery.` `getStocksByQuery()` is the basic search method and returns a list of `Stocks.` A more advanced search may be performed with `getStocksBySearch().` It accepts a `StockSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getStocksBySearch()` returns a `StockSearchResults` that can be used to access the resulting `StockList` or be used to perform a search within the result set through `StockSearch.` This session defines views that offer differing behaviors for searching. federated warehouse view: searches include stocks in warehouses of which this warehouse is an ancestor in the warehouse hierarchy isolated warehouse view: searches are restricted to stocks in this warehouse Stocks may have a query record indicated by their respective record types. The queryrecord is accessed via the `StockQuery.`
Method	getStockSearch
Description	Gets a stock search.
Return	`osid.inventory.StockSearch`		the stock search
Compliance	`mandatory`		This method must be implemented.
Method	getStockSearchOrder
Description	Gets a stock search order. The `StockSearchOrder` is supplied to a `StockSearch` to specify the ordering of results.
Return	`osid.inventory.StockSearchOrder`		the stock search order
Compliance	`mandatory`		This method must be implemented.
Method	getStocksBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.inventory.StockQuery`	`stockQuery`	the stock query
Parameters	`osid.inventory.StockSearch`	`stockSearch`	the stock search
Return	`osid.inventory.StockSearchResults`		the stock search results
Errors	NULL_ARGUMENT		`stockQuery` or `stockSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`stockQuery` or `stockSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getStockQueryFromInspector
Description	Gets a stock query from an inspector. The inspector is available from a `StockSearchResults.`
Parameters	`osid.assessment.ItemQueryInspector`	`stockQueryInspector`	a stock query inspector
Return	`osid.inventory.StockQuery`		the stock query
Errors	NULL_ARGUMENT		`stockQueryInspector` is `null`
Errors	UNSUPPORTED		`stockQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.