OSID Logo
OSID Specifications
billing payment package
Version 3.1.0
Interfaceosid.billing.payment.PayerSearch
Implementsosid.OsidSearch
Used Byosid.billing.payment.PayerSearchSession
Description

The search interface for governing payer searches.

MethodsearchAmongPayers
Description

Execute this search among the given list of payers.

Parametersosid.id.IdListpayerIds list of payers
ErrorsNULL_ARGUMENT payerIds is null
Compliancemandatory This method must be implemented.
MethodorderPayerResults
Description

Specify an ordering to the search results.

Parametersosid.billing.payment.PayerSearchOrderpayerSearchOrder payer search order
ErrorsNULL_ARGUMENT payerSearchOrder is null
UNSUPPORTED payerSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetPayerSearchRecord
Description

Gets the payer search 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.PayerSearchRecord the payer search record
ErrorsNULL_ARGUMENT payerSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(payerSearchRecordType) is false
Compliancemandatory This method must be implemented.