Interface PaymentSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface PaymentSearch
extends OsidSearch

The search interface for governing payment searches.

Method Summary

Modifier and Type	Method	Description
PaymentSearchRecord	getPaymentSearchRecord(Type paymentSearchRecordType)	Gets the payment search record corresponding to the given payment search record Type.
void	orderPaymentResults(PaymentSearchOrder paymentSearchOrder)	Specify an ordering to the search results.
void	searchAmongPayments(IdList paymentIds)	Execute this search among the given list of payments.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongPayments

void searchAmongPayments(IdList paymentIds)

Execute this search among the given list of payments.

Parameters:

paymentIds - list of payers

Throws:

NullArgumentException - paymentIds is null

Compliance:

mandatory - This method must be implemented.

orderPaymentResults

void orderPaymentResults(PaymentSearchOrder paymentSearchOrder)

Specify an ordering to the search results.

Parameters:

paymentSearchOrder - payer search order

Throws:

NullArgumentException - paymentSearchOrder is null

UnsupportedException - paymentSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getPaymentSearchRecord

PaymentSearchRecord getPaymentSearchRecord(Type paymentSearchRecordType)
                                    throws OperationFailedException

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.

Parameters:

paymentSearchRecordType - a payer search record type

Returns:

the payment search record

Throws:

NullArgumentException - paymentSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(paymentSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.