Interface | osid.billing.payment.PayerSearchSession | ||
---|---|---|---|
Implements | osid.billing.payment.PayerQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Payers may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getPayerSearch | ||
Description |
Gets a payer search. | ||
Return | osid.billing.payment.PayerSearch | the payer search | |
Compliance | mandatory | This method must be implemented. | |
Method | getPayerSearchOrder | ||
Description |
Gets a payer search order. The | ||
Return | osid.billing.payment.PayerSearchOrder | the payer search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getPayersBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.billing.payment.PayerQuery | payerQuery | the payer query |
osid.billing.payment.PayerSearch | payerSearch | the payer search | |
Return | osid.billing.payment.PayerSearchResults | the payer search results | |
Errors | NULL_ARGUMENT | payerQuery or payerSearch is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | payerQuery or payerSearch is not of this
service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPayerQueryFromInspector | ||
Description |
Gets a payer query from an inspector. The inspector is
available from a | ||
Parameters | osid.billing.payment.PayerQueryInspector | payerQueryInspector | a payer query inspector |
Return | osid.billing.payment.PayerQuery | the payer query | |
Errors | NULL_ARGUMENT | payerQueryInspector is null | |
UNSUPPORTED | payerQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |