Interface | osid.billing.payment.PaymentSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getPayments | ||
Description |
Gets the payment list resulting from a search. | ||
Return | osid.billing.payment.PaymentList | the payment list | |
Errors | ILLEGAL_STATE | the payment list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getPaymentQueryInspector | ||
Description |
Gets the inspector for the query to examine the periods used in the search. | ||
Return | osid.billing.payment.PaymentQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getPaymentSearchResultsRecord | ||
Description |
Gets the payment search results record corresponding to
the given payment search record | ||
Parameters | osid.type.Type | paymentSearchRecordType | a payment search record type |
Return | osid.billing.payment.records.PaymentSearchResultsRecord | the payment search results record | |
Errors | NULL_ARGUMENT | paymentSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(paymentSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |