| Interface | osid.billing.CustomerSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getCustomers | ||
| Description |
Gets the customer list resulting from a search. | ||
| Return | osid.billing.CustomerList | the customer list | |
| Errors | ILLEGAL_STATE | the customer list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCustomerQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.billing.CustomerQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCustomerSearchResultsRecord | ||
| Description |
Gets the customer search results record corresponding
to the given customer search record | ||
| Parameters | osid.type.Type | customerSearchRecordType | a customer search record type |
| Return | osid.billing.records.CustomerSearchResultsRecord | the customer search results record | |
| Errors | NULL_ARGUMENT | customerSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(customerSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |