OSID Logo
OSID Specifications
billing payment package
Version 3.1.0
Interfaceosid.billing.payment.PaymentSearch
Implementsosid.OsidSearch
Used Byosid.billing.payment.PaymentSearchSession
Description

The search interface for governing payment searches.

MethodsearchAmongPayments
Description

Execute this search among the given list of payments.

Parametersosid.id.IdListpaymentIds list of payers
ErrorsNULL_ARGUMENT paymentIds is null
Compliancemandatory This method must be implemented.
MethodorderPaymentResults
Description

Specify an ordering to the search results.

Parametersosid.billing.payment.PaymentSearchOrderpaymentSearchOrder payer search order
ErrorsNULL_ARGUMENT paymentSearchOrder is null
UNSUPPORTED paymentSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetPaymentSearchRecord
Description

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

Parametersosid.type.TypepaymentSearchRecordType a payer search record type
Returnosid.billing.payment.records.PaymentSearchRecord the payment search record
ErrorsNULL_ARGUMENT paymentSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(paymentSearchRecordType) is false
Compliancemandatory This method must be implemented.