OSID - osid.ordering.OrderItemSmartStoreSession Service Interface Definition

Interface	osid.ordering.OrderItemSmartStoreSession
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 `OrderItemQuery` can be retrieved from this session and mapped to this `Store` to create a virtual collection of `OrderItems`. The order items may be sequenced using the `OrderItemSearchOrder` from this session. This `Store` has a default query that matches any order item and a default search order that specifies no sequencing. The queries may be examined using a `OrderItemQueryInspector`. The query may be modified by converting the inspector back to a `OrderItemQuery`. Like all `OsidSessions`, `OrderItemSmartStoreSessions` 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	getOrderItemQuery
Description	Gets an order item query.
Return	`osid.ordering.OrderItemQuery`		the order item query
Compliance	`mandatory`		This method must be implemented.
Method	getOrderItemSearchOrder
Description	Gets an order item search order.
Return	`osid.ordering.OrderItemSearchOrder`		the order item search order
Compliance	`mandatory`		This method must be implemented.
Method	applyOrderItemQuery
Description	Applies an order item query to this store.
Parameters	`osid.ordering.OrderItemQuery`	`orderItemQuery`	the order item query
Errors	NULL_ARGUMENT		`orderItemQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`orderItemQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectOrderItemQuery
Description	Gets an order item query inspector for this store.
Return	`osid.ordering.OrderItemQueryInspector`		the order item query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyOrderItemSequencing
Description	Applies an order item search order to this store.
Parameters	`osid.ordering.OrderItemSearchOrder`	`orderItemSearchOrder`	the order item search order
Errors	NULL_ARGUMENT		`orderItemSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`orderItemSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getOrderItemQueryFromInspector
Description	Gets an order item query from an inspector.
Parameters	`osid.ordering.OrderItemQueryInspector`	`orderItemQueryInspector`	a query inspector
Return	`osid.ordering.OrderItemQuery`		the order item query
Errors	NULL_ARGUMENT		`orderItemQueryInspector` is `null`
Errors	UNSUPPORTED		`orderItemQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.