| Interface | osid.ordering.OrderItemSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Used By | osid.ordering.OrderItemSearchSession | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getOrderItems | ||
| Description |
Gets the order item list resulting from a search. | ||
| Return | osid.ordering.OrderItemList | the order item list | |
| Errors | ILLEGAL_STATE | list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOrderItemQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terns used in the search. | ||
| Return | osid.ordering.OrderItemQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOrderItemSearchResultsRecord | ||
| Description |
Gets the order item search results record corresponding to the given order item search record Type. This method is used to retrieve an object implementing the requested recor. | ||
| Parameters | osid.type.Type | orderItemSearchRecordType | an order item search record type |
| Return | osid.ordering.records.OrderItemSearchResultsRecord | the order item search results record | |
| Errors | NULL_ARGUMENT | OrderItemSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(order itemSearchRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |