| Interface | osid.billing.payment.PayerSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getPayers | ||
| Description |
Gets the payer list resulting from a search. | ||
| Return | osid.billing.payment.PayerList | the payer list | |
| Errors | ILLEGAL_STATE | the payer list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPayerQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.billing.payment.PayerQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPayerSearchResultsRecord | ||
| Description |
Gets the payer search results record corresponding to
the given payer search record | ||
| Parameters | osid.type.Type | payerSearchRecordType | a payer search record type |
| Return | osid.billing.payment.records.PayerSearchResultsRecord | the payer search results record | |
| Errors | NULL_ARGUMENT | payerSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(payerSearchRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |