OSID - osid.ordering.StoreSearchSession Service Interface Definition

Interface	osid.ordering.StoreSearchSession
Implements	`osid.ordering.StoreQuerySession`
Used By	`osid.ordering.OrderingManager`
Used By	`osid.ordering.OrderingProxyManager`
Description	This session provides methods for searching `Store` objects. The search query is constructed using the `StoreQuery`. The store record `Type` also specifies the record for the store query. `getStoresByQuery()` is the basic search method and returns a list of `Store` elements. A more advanced search may be performed with `getStoresBySearch()`. It accepts a `StoreSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getStoresBySearch()` returns a `StoreSearchResults` that can be used to access the resulting `StoreList` or be used to perform a search within the result set through `StoreSearch`. Stores may have a query record indicated by their respective record types. The query record is accessed via the `StoreQuery`. The returns in this session may not be cast directly to these interfaces.
Method	getStoreSearch
Description	Gets a store search.
Return	`osid.ordering.StoreSearch`		the store search
Compliance	`mandatory`		This method must be implemented.
Method	getStoreSearchOrder
Description	Gets a store search order. The `StoreSearchOrder` is supplied to a `StoreSearch` to specify the ordering of results.
Return	`osid.ordering.StoreSearchOrder`		the store search order
Compliance	`mandatory`		This method must be implemented.
Method	getStoresBySearch
Description	Gets the search results matching the given search.
Parameters	`osid.ordering.StoreQuery`	`storeQuery`	the store query
Parameters	`osid.ordering.StoreSearch`	`storeSearch`	the store search
Return	`osid.ordering.StoreSearchResults`		the store search results
Errors	NULL_ARGUMENT		`storeQuery` or `storeSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`storeQuery` or `storeSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getStoreQueryFromInspector
Description	Gets an entry query from an inspector. The inspector is available from a `StoreSearchResults`.
Parameters	`osid.ordering.StoreQueryInspector`	`storeQueryInspector`	a query inspector
Return	`osid.ordering.StoreQuery`		the store query
Errors	NULL_ARGUMENT		`storeQueryInspector` is `null`
Errors	UNSUPPORTED		`storeQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.