OSID - osid.ordering.PriceSmartStoreSession Service Interface Definition

Interface	osid.ordering.PriceSmartStoreSession
Implements	`osid.OsidSession`
Used By	`osid.ordering.OrderingManager`
Used By	`osid.ordering.OrderingProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `PriceQuery` can be retrieved from this session and mapped to this `Store` to create a virtual collection of `Prices`. The prices may be sequenced using the `PriceSearchOrder` from this session. This `Store` has a default query that matches any price and a default search order that specifies no sequencing. The queries may be examined using a `PriceQueryInspector`. The query may be modified by converting the inspector back to a `PriceQuery`. Like all `OsidSessions`, `PriceSmartStoreSessions` 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` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSmartStores
Description	Tests if this user can manage smart stores. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.
Return	`boolean`		`false` if smart store management is not authorized, `true` otherwise
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	getPriceSearchOrder
Description	Gets a price search order.
Return	`osid.ordering.PriceSearchOrder`		the price search order
Compliance	`mandatory`		This method must be implemented.
Method	applyPriceQuery
Description	Applies a price query to this store.
Parameters	`osid.ordering.PriceQuery`	`priceQuery`	the price query
Errors	NULL_ARGUMENT		`priceQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`priceQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectPriceQuery
Description	Gets a price query inspector for this store.
Return	`osid.ordering.PriceQueryInspector`		the price query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyPriceSequencing
Description	Applies a price search order to this store.
Parameters	`osid.ordering.PriceSearchOrder`	`priceSearchOrder`	the price search order
Errors	NULL_ARGUMENT		`priceSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`priceSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getPriceQueryFromInspector
Description	Gets a price query from an inspector.
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.