OSID Logo
OSID Specifications
billing payment package
Version 3.0.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.IdListpayerIdslist of payers
ErrorsNULL_ARGUMENTpayerIds is null
CompliancemandatoryThis method must be implemented.
MethodorderPayerResults
Description

Specify an ordering to the search results.

Parametersosid.billing.payment.PayerSearchOrderpayerSearchOrderpayer search order
ErrorsNULL_ARGUMENTpayerSearchOrder is null
UNSUPPORTEDpayerSearchOrder 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_ARGUMENTpayerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(payerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.