| Interface | osid.billing.payment.PaymentSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description | 
                 The search interface for governing payment searches.  | ||
| Method | searchAmongPayments | ||
| Description | 
                     Execute this search among the given list of payments.  | ||
| Parameters | osid.id.IdList | paymentIds | list of payers | 
| Errors | NULL_ARGUMENT |  paymentIds  is  null   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderPaymentResults | ||
| Description | 
                     Specify an ordering to the search results.  | ||
| Parameters | osid.billing.payment.PaymentSearchOrder | paymentSearchOrder | payer search order | 
| Errors | NULL_ARGUMENT |  paymentSearchOrder  is  null   |                 |
| UNSUPPORTED |  paymentSearchOrder  is not of this service  |                 ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getPaymentSearchRecord | ||
| Description | 
                     Gets the payment search record corresponding to the 
                    given payment search record   | ||
| Parameters | osid.type.Type | paymentSearchRecordType | a payer search record type | 
| Return | osid.billing.payment.records.PaymentSearchRecord | the payment search 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. | |