OSID Logo
OSID Specifications
billing payment package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.payment.PayerSearch
Implementsosid.OsidSearch
Description

The search interface for governing payer searches.

MethodsearchAmongPayers
Description

Execute this search among the given list of payers.

Parametersosid.id.IdListpayerIdslist of payers
ErrorsNULL_ARGUMENT payerIds is null
CompliancemandatoryThis method must be implemented.
MethodorderPayerResults
Description

Specify an ordering to the search results.

Parametersosid.billing.payment.PayerSearchOrderpayerSearchOrderpayer search order
ErrorsNULL_ARGUMENT payerSearchOrder is null
UNSUPPORTED payerSearchOrder is not of this service
CompliancemandatoryThis 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.TypepayerSearchRecordTypea payer search record type
Returnosid.billing.payment.records.PayerSearchRecordthe payer search record
ErrorsNULL_ARGUMENT payerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(payerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.