OSID Logo
OSID Specifications
billing payment package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.payment.PaymentSearchResults
Implementsosid.OsidSearchResults
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.PaymentListthe payment list
ErrorsILLEGAL_STATEthe payment list has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetPaymentQueryInspector
Description

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

Returnosid.billing.payment.PaymentQueryInspectorthe query inspector
CompliancemandatoryThis 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.TypepaymentSearchRecordTypea payment search record type
Returnosid.billing.payment.records.PaymentSearchResultsRecordthe payment search results record
ErrorsNULL_ARGUMENT paymentSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(paymentSearchRecordType) is false
CompliancemandatoryThis method must be implemented.