Interface PayerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface PayerSearch
extends OsidSearch

The search interface for governing payer searches.

Method Summary

Modifier and Type	Method	Description
PayerSearchRecord	getPayerSearchRecord(Type payerSearchRecordType)	Gets the payer search record corresponding to the given payer search record Type .
void	orderPayerResults(PayerSearchOrder payerSearchOrder)	Specify an ordering to the search results.
void	searchAmongPayers(IdList payerIds)	Execute this search among the given list of payers.

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

searchAmongPayers

void searchAmongPayers(IdList payerIds)

Execute this search among the given list of payers.

Parameters:

payerIds - list of payers

Throws:

NullArgumentException - payerIds is null

Compliance:

mandatory - This method must be implemented.

orderPayerResults

void orderPayerResults(PayerSearchOrder payerSearchOrder)

Specify an ordering to the search results.

Parameters:

payerSearchOrder - payer search order

Throws:

NullArgumentException - payerSearchOrder is null

UnsupportedException - payerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getPayerSearchRecord

PayerSearchRecord getPayerSearchRecord(Type payerSearchRecordType)
                                throws OperationFailedException

Gets the payer search 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 record

Throws:

NullArgumentException - payerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(payerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.