OSID - osid.ordering.PriceSearchSession Service Interface Definition

Interface	osid.ordering.PriceSearchSession
Implements	`osid.ordering.PriceQuerySession`
Used By	`osid.ordering.OrderingManager`
Used By	`osid.ordering.OrderingProxyManager`
Description	This session provides methods for searching `Price` objects. The search query is constructed using the `PriceQuery`. The price record `Type` also specifies the record for the price query. `getPricesByQuery()` is the basic search method and returns a list of `Price` elements. A more advanced search may be performed with `getPricesBySearch()`. It accepts a `PriceSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getPricesBySearch()` returns a `PriceSearchResults` that can be used to access the resulting `PriceList` or be used to perform a search within the result set through `PriceSearch`. Price schedules may have a query record indicated by their respective record types. The query record is accessed via the `PriceQuery`. The returns in this session may not be cast directly to these interfaces. Like all `OsidSessions`, `PriceSearchSessions` are dedicated to single processing threads and a single authenticated user.
Method	getPriceSearch
Description	Gets a price search.
Return	`osid.ordering.PriceSearch`		the price search
Compliance	`mandatory`		This method must be implemented.
Method	getPriceSearchOrder
Description	Gets a price search order. The `PriceSearchOrder` is supplied to a `PriceSearch` to specify the ordering of results.
Return	`osid.ordering.PriceSearchOrder`		the price search order
Compliance	`mandatory`		This method must be implemented.
Method	getPricesBySearch
Description	Gets the price search results matching the given search.
Parameters	`osid.ordering.PriceQuery`	`priceQuery`	the price query
Parameters	`osid.ordering.PriceSearch`	`priceSearch`	the price search
Return	`osid.ordering.PriceSearchResults`		the price search results
Errors	NULL_ARGUMENT		`priceQuery` or `priceSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`priceQuery` or `priceSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getPriceQueryFromInspector
Description	Gets a price query from an inspector. The inspector is available from a `PriceSearchResults`.
Parameters	`osid.ordering.PriceQueryInspector`	`priceQueryInspector`	a query inspector
Return	`osid.ordering.PriceQuery`		the price query
Errors	NULL_ARGUMENT		`priceQueryInspector` is `null`
Errors	UNSUPPORTED		`priceQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.