Interface | osid.ordering.OrderSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getOrders | ||
Description |
Gets the order list resulting from a search. | ||
Return | osid.ordering.OrderList | the order list | |
Errors | ILLEGAL_STATE | list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getOrderQueryInspector | ||
Description |
Gets the inspector for the query to examine the terns used in the search. | ||
Return | osid.ordering.OrderQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getOrderSearchResultsRecord | ||
Description |
Gets the order search results record corresponding to
the given order search record | ||
Parameters | osid.type.Type | orderSearchRecordType | a order search record type |
Return | osid.ordering.records.OrderSearchResultsRecord | the order search record | |
Errors | NULL_ARGUMENT | orderSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(orderSearchRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |