OSID Logo
OSID Specifications
billing payment package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.payment.PayerSearchResults
Implementsosid.OsidSearchResults
Description

This interface provides a means to capture results of a search.

MethodgetPayers
Description

Gets the payer list resulting from a search.

Returnosid.billing.payment.PayerListthe payer list
ErrorsILLEGAL_STATEthe payer list has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetPayerQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.billing.payment.PayerQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetPayerSearchResultsRecord
Description

Gets the payer search results record corresponding to the given payer search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypepayerSearchRecordTypea payer search record type
Returnosid.billing.payment.records.PayerSearchResultsRecordthe payer search results record
ErrorsNULL_ARGUMENT payerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(payerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.