OSID - osid.ordering.OrderSmartStoreSession Service Interface Definition

Interface	osid.ordering.OrderSmartStoreSession
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. An `OrderQuery` can be retrieved from this session and mapped to this `Store` to create a virtual collection of `Orders`. The orders may be sequenced using the `OrderSearchOrder` from this session. This `Store` has a default query that matches any order and a default search order that specifies no sequencing. The queries may be examined using an `OrderQueryInspector`. The query may be modified by converting the inspector back to an `OrderQuery`.
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	getOrderQuery
Description	Gets an order query.
Return	`osid.ordering.OrderQuery`		the order query
Compliance	`mandatory`		This method must be implemented.
Method	getOrderSearchOrder
Description	Gets an order search order.
Return	`osid.ordering.OrderSearchOrder`		the order search order
Compliance	`mandatory`		This method must be implemented.
Method	applyOrderQuery
Description	Applies an order query to this store.
Parameters	`osid.ordering.OrderQuery`	`orderQuery`	the order query
Errors	NULL_ARGUMENT		`orderQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`orderQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectOrderQuery
Description	Gets an order query inspector for this store.
Return	`osid.ordering.OrderQueryInspector`		the order query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyOrderSequencing
Description	Applies an order search order to this store.
Parameters	`osid.ordering.OrderSearchOrder`	`orderSearchOrder`	the order search order
Errors	NULL_ARGUMENT		`orderSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`orderSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getOrderQueryFromInspector
Description	Gets an order query from an inspector.
Parameters	`osid.ordering.OrderQueryInspector`	`orderQueryInspector`	a query inspector
Return	`osid.ordering.OrderQuery`		the order query
Errors	NULL_ARGUMENT		`orderQueryInspector` is `null`
Errors	UNSUPPORTED		`orderQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.