OSID - osid.ordering.OrderSearchSession Service Interface Definition

Interface	osid.ordering.OrderSearchSession
Implements	`osid.ordering.OrderQuerySession`
Used By	`osid.ordering.OrderingManager`
Used By	`osid.ordering.OrderingProxyManager`
Description	This session provides methods for searching `Order` objects. The search query is constructed using the `OrderQuery`. The order record `Type` also specifies the record for the order query. `getOrdersByQuery()` is the basic search method and returns a list of `Order` elements. A more advanced search may be performed with `getOrdersBySearch()`. It accepts an `OrderSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getOrdersBySearch()` returns an `OrderSearchResults` that can be used to access the resulting `OrderList` or be used to perform a search within the result set through `OrderSearch`. Orders may have a query record indicated by their respective record types. The query record is accessed via the `OrderQuery`. The returns in this session may not be cast directly to these interfaces.
Method	getOrderSearch
Description	Gets an order search.
Return	`osid.ordering.OrderSearch`		the order search
Compliance	`mandatory`		This method must be implemented.
Method	getOrderSearchOrder
Description	Gets an order search order. The `OrderSearchOrder` is supplied to an `OrderSearch` to specify the ordering of results.
Return	`osid.ordering.OrderSearchOrder`		the order search order
Compliance	`mandatory`		This method must be implemented.
Method	getOrdersBySearch
Description	Gets the search results matching the given search.
Parameters	`osid.ordering.OrderQuery`	`orderQuery`	the order query
Parameters	`osid.ordering.OrderSearch`	`orderSearch`	the order search
Return	`osid.ordering.OrderSearchResults`		the order search results
Errors	NULL_ARGUMENT		`orderQuery` or `orderSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`orderQuery` or `orderSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getOrderQueryFromInspector
Description	Gets an entry query from an inspector. The inspector is available from an `OrderSearchResults`.
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.