OSID - osid.ordering.PriceQuerySession Service Interface Definition

Interface	osid.ordering.PriceQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.ordering.PriceSearchSession`
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. 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`, `PriceQuerySessions` are dedicated to single processing threads and a single authenticated user.
Method	getStoreId
Description	Gets the `Store` `Id` associated with this session.
Return	`osid.id.Id`		the `Store Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getStore
Description	Gets the `Store` associated with this session.
Return	`osid.ordering.Store`		the store
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchPrices
Description	Tests if this user can perform `Price` searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer search operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedStoreView
Description	Federates the view for methods in this session. A federated view will include prices in stores which are children of this store in the store hierarchy.
Compliance	`mandatory`		This method must be implemented.
Method	useIsolatedStoreView
Description	Isolates the view for methods in this session. An isolated view restricts searches to this store only.
Compliance	`mandatory`		This method must be implemented.
Method	getPriceQuery
Description	Gets a price query.
Return	`osid.ordering.PriceQuery`		the price query
Compliance	`mandatory`		This method must be implemented.
Method	getPricesByQuery
Description	Gets a list of `Prices` matching the given price query.
Parameters	`osid.ordering.PriceQuery`	`priceQuery`	the price query query
Return	`osid.ordering.PriceList`		the returned `PriceList`
Errors	NULL_ARGUMENT		`priceQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`priceQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.