public interface BankSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
BankQueryInspector |
getBankQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
BankList |
getBanks()
Gets the bank list resulting from a search.
|
BankSearchResultsRecord |
getBankSearchResultsRecord(Type bankSearchRecordType)
Gets the bank search results record corresponding to the given bank
search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
BankList getBanks()
IllegalStateException
- the bank list has already been
retrievedmandatory
- This method must be implemented. BankQueryInspector getBankQueryInspector()
mandatory
- This method must be implemented. BankSearchResultsRecord getBankSearchResultsRecord(Type bankSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.bankSearchRecordType
- a bank search record typeNullArgumentException
- bankSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(bankSearchRecordType)
is false
mandatory
- This method must be implemented.