OSID Logo
OSID Specifications
billing payment package
Version 3.1.0
Interfaceosid.billing.payment.PaymentSearchResults
Implementsosid.OsidSearchResults
Used Byosid.billing.payment.PaymentSearchSession
Description

This interface provides a means to capture results of a search.

MethodgetPayments
Description

Gets the payment list resulting from a search.

Returnosid.billing.payment.PaymentList the payment list
ErrorsILLEGAL_STATE the payment list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetPaymentQueryInspector
Description

Gets the inspector for the query to examine the periods used in the search.

Returnosid.billing.payment.PaymentQueryInspector the query inspector
Compliancemandatory This method must be implemented.
MethodgetPaymentSearchResultsRecord
Description

Gets the payment search results 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 payment search record type
Returnosid.billing.payment.records.PaymentSearchResultsRecord the payment search results record
ErrorsNULL_ARGUMENT paymentSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(paymentSearchRecordType) is false
Compliancemandatory This method must be implemented.