OSID - osid.ordering.OrderItemSearchSession Service Interface Definition

Interface	osid.ordering.OrderItemSearchSession
Implements	`osid.ordering.OrderItemQuerySession`
Used By	`osid.ordering.OrderingManager`
Used By	`osid.ordering.OrderingProxyManager`
Description	This session provides methods for searching `OrderItem` objects. The search query is constructed using the `OrderItemQuery`. The order item record `Type` also specifies the record for the order item query. `getOrderItemsByQuery()` is the basic search method and returns a list of `OrderItem` elements. A more advanced search may be performed with `getOrderItemsBySearch()`.It accepts a `OrderItemSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getOrderItemsBySearch()` returns a `OrderItemSearchResults` that can be used to access the resulting `OrderItemList` or be used to perform a search within the result set through `OrderItemSearch`. OrderItems may have a query record indicated by their respective record types. The query record is accessed via the `OrderItemQuery`. The returns in this session may not be cast directly to these interfaces. Like all `OsidSessions`, `OrderItemSearchSessions` are dedicated to single processing threads and a single authenticated user.
Method	getOrderItemSearch
Description	Gets an order item search.
Return	`osid.ordering.OrderItemSearch`		the order item search
Compliance	`mandatory`		This method must be implemented.
Method	getOrderItemSearchOrder
Description	Gets an order item search order. The `OrderItemSearchOrder` is supplied to an `OrderItemSearch` to specify the ordering of results.
Return	`osid.ordering.OrderItemSearchOrder`		the order item search order
Compliance	`mandatory`		This method must be implemented.
Method	getOrderItemsBySearch
Description	Gets the search results matching the given search.
Parameters	`osid.ordering.OrderItemQuery`	`orderItemQuery`	the order item query
Parameters	`osid.ordering.OrderItemSearch`	`orderItemSearch`	the order item search
Return	`osid.ordering.OrderItemSearchResults`		the order item search results
Errors	NULL_ARGUMENT		`orderItemQuery` or `orderItemSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`orderItemQuery` or `orderItemSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getOrderItemQueryFromInspector
Description	Gets an order item query from an inspector. The inspector is available from a `OrderItemSearchResults`.
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.