OSID Logo
OSID Specifications
billing payment package
Version 3.1.0
Interfaceosid.billing.payment.PayerSearchResults
Implementsosid.OsidSearchResults
Used Byosid.billing.payment.PayerSearchSession
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.PayerList the payer list
ErrorsILLEGAL_STATE the payer list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetPayerQueryInspector
Description

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

Returnosid.billing.payment.PayerQueryInspector the query inspector
Compliancemandatory This 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.TypepayerSearchRecordType a payer search record type
Returnosid.billing.payment.records.PayerSearchResultsRecord the payer search results record
ErrorsNULL_ARGUMENT payerSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(payerSearchRecordType) is false
Compliancemandatory This method must be implemented.