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

Modifier and Type	Method	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 .This method is used to retrieve an object implementing the requested record.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

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 OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

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.