OSID - osid.ordering.PriceScheduleSmartStoreSession Service Interface Definition

Interface	osid.ordering.PriceScheduleSmartStoreSession
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 `PriceScheduleQuery` can be retrieved from this session and mapped to this `Store` to create a virtual collection of `PriceSchedules`. The prices may be sequenced using the `PriceScheduleSearchOrder` from this session. This `Store` has a default query that matches any price schedule and a default search order that specifies no sequencing. The queries may be examined using a `PriceScheduleQueryInspector`. The query may be modified by converting the inspector back to a `PriceScheduleQuery`.
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	getPriceScheduleQuery
Description	Gets a price schedule query.
Return	`osid.ordering.PriceScheduleQuery`		the price schedule query
Compliance	`mandatory`		This method must be implemented.
Method	getPriceScheduleSearchOrder
Description	Gets a price schedule search order.
Return	`osid.ordering.PriceScheduleSearchOrder`		the price schedule search order
Compliance	`mandatory`		This method must be implemented.
Method	applyPriceScheduleQuery
Description	Applies a price schedule query to this store.
Parameters	`osid.ordering.PriceScheduleQuery`	`priceQuery`	the price schedule query
Errors	NULL_ARGUMENT		`priceScheduleQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`priceScheduleQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectPriceScheduleQuery
Description	Gets a price schedule query inspector for this store.
Return	`osid.ordering.PriceScheduleQueryInspector`		the price schedule query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyPriceScheduleSequencing
Description	Applies a price schedule search order to this store.
Parameters	`osid.ordering.PriceScheduleSearchOrder`	`priceScheduleSearchOrder`	the price schedule search order
Errors	NULL_ARGUMENT		`priceScheduleSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`priceScheduleSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getPriceScheduleQueryFromInspector
Description	Gets a price schedule query from an inspector.
Parameters	`osid.ordering.PriceScheduleQueryInspector`	`priceScheduleQueryInspector`	a query inspector
Return	`osid.ordering.PriceScheduleQuery`		the price schedule query
Errors	NULL_ARGUMENT		`priceScheduleQueryInspector` is `null`
Errors	UNSUPPORTED		`priceScheduleQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.