Interface | osid.billing.payment.PayerSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing payer searches. | ||
Method | searchAmongPayers | ||
Description |
Execute this search among the given list of payers. | ||
Parameters | osid.id.IdList | payerIds | list of payers |
Errors | NULL_ARGUMENT | payerIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderPayerResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.billing.payment.PayerSearchOrder | payerSearchOrder | payer search order |
Errors | NULL_ARGUMENT | payerSearchOrder is null | |
UNSUPPORTED | payerSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPayerSearchRecord | ||
Description |
Gets the payer search record corresponding to the given
payer search record | ||
Parameters | osid.type.Type | payerSearchRecordType | a payer search record type |
Return | osid.billing.payment.records.PayerSearchRecord | the payer search 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. |