public interface PayerSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
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. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
PayerList getPayers()
IllegalStateException
- the payer list has already been
retrievedmandatory
- This method must be implemented. PayerQueryInspector getPayerQueryInspector()
mandatory
- This method must be implemented. PayerSearchResultsRecord getPayerSearchResultsRecord(Type payerSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.payerSearchRecordType
- a payer search record typeNullArgumentException
- payerSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(payerSearchRecordType)
is false
mandatory
- This method must be implemented.