org.osid.billing.payment

Interface PayerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface PayerSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
PayerQueryInspector	getPayerQueryInspector() Gets the inspector for the query to examine the terms used in the search.
PayerList	getPayers() Gets the payer list resulting from a search.
PayerSearchResultsRecord	getPayerSearchResultsRecord(Type payerSearchRecordType) Gets the payer search results record corresponding to the given payer search record Type.

Methods inherited from interface org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getPayers

PayerList getPayers()

Gets the payer list resulting from a search.

Returns:

the payer list

Throws:

IllegalStateException - the payer list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getPayerQueryInspector

PayerQueryInspector getPayerQueryInspector()

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

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getPayerSearchResultsRecord

PayerSearchResultsRecord getPayerSearchResultsRecord(Type payerSearchRecordType)
                                                     throws OperationFailedException

Gets the payer search results record corresponding to the given payer search record Type. This method is used to retrieve an object implementing the requested record.

Parameters:

payerSearchRecordType - a payer search record type

Returns:

the payer search results record

Throws:

NullArgumentException - payerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(payerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.