OSID - osid.ordering.rules.PriceEnablerSmartStoreSession Service Interface Definition

Interface	osid.ordering.rules.PriceEnablerSmartStoreSession
Implements	`osid.OsidSession`
Used By	`osid.ordering.rules.OrderingRulesManager`
Used By	`osid.ordering.rules.OrderingRulesProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic stores. A `PriceEnablerQuery` can be retrieved from this session and mapped to this `Store` to create a virtual collection of price enablers. The price enablers may be sequenced using the `PriceEnablerSearchOrder` from this session. This `Store` has a default query that matches any price enabler and a default search order that specifies no sequencing. The queries may be examined using a `PriceEnablerQueryInspector`. The query may be modified by converting the inspector back to a `PriceEnablerQuery`.
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	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	getPriceEnablerQuery
Description	Gets a price enabler query.
Return	`osid.ordering.rules.PriceEnablerQuery`		the price enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getPriceEnablerSearchOrder
Description	Gets a price enabler search order.
Return	`osid.ordering.rules.PriceEnablerSearchOrder`		the price enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	applyPriceEnablerQuery
Description	Applies a price enabler query to this store.
Parameters	`osid.ordering.rules.PriceEnablerQuery`	`priceEnablerQuery`	the price enabler query
Errors	NULL_ARGUMENT		`priceEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`priceEnablerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectPriceEnablerQuery
Description	Gets a price enabler query inspector for this store.
Return	`osid.ordering.rules.PriceEnablerQueryInspector`		the price enabler query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyPriceEnablerSequencing
Description	Applies a price enabler search order to this store.
Parameters	`osid.ordering.rules.PriceEnablerSearchOrder`	`priceEnablerSearchOrder`	the price enabler search order
Errors	NULL_ARGUMENT		`priceEnablerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`priceEnablerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getPriceEnablerQueryFromInspector
Description	Gets a price enabler query from an inspector.
Parameters	`osid.ordering.rules.PriceEnablerQueryInspector`	`priceEnablerQueryInspector`	a price enabler query inspector
Return	`osid.ordering.rules.PriceEnablerQuery`		the price enabler query
Errors	NULL_ARGUMENT		`priceEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`priceEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.