| Interface | osid.billing.ItemSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getItems | ||
| Description |
Gets the item list resulting from a search. | ||
| Return | osid.billing.ItemList | the item list | |
| Errors | ILLEGAL_STATE | the item list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getItemQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.billing.ItemQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getItemSearchResultsRecord | ||
| Description |
Gets the item search results record corresponding to
the given item search record | ||
| Parameters | osid.type.Type | itemSearchRecordType | a item search record type |
| Return | osid.billing.records.ItemSearchResultsRecord | the item search results record | |
| Errors | NULL_ARGUMENT | itemSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(itemSearchRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |