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

The search interface for governing payment searches.

MethodsearchAmongPayments
Description

Execute this search among the given list of payments.

Parametersosid.id.IdListpaymentIdslist of payers
ErrorsNULL_ARGUMENT paymentIds is null
CompliancemandatoryThis method must be implemented.
MethodorderPaymentResults
Description

Specify an ordering to the search results.

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