| Interface | osid.ordering.OrderItemSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Used By | osid.ordering.OrderItemSearchSession | ||
| Description |
The search interface for governing order item searches. | ||
| Method | searchAmongOrderItems | ||
| Description |
Execute this search among the given list of order items. | ||
| Parameters | osid.id.IdList | orderItemIds | list of order items |
| Errors | NULL_ARGUMENT | orderItemIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderOrderItemResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.ordering.OrderItemSearchOrder | orderItemSearchOrder | order item search order |
| Errors | NULL_ARGUMENT | orderItemSearchOrder is null | |
| UNSUPPORTED | orderItemSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getOrderItemSearchRecord | ||
| Description |
Gets the order item search record corresponding to the
given order item search record | ||
| Parameters | osid.type.Type | orderItemSearchRecordType | an order item search record type |
| Return | osid.ordering.records.OrderItemSearchRecord | the order item search 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. | |