Interface BankSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface BankSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	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 .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

getBanks

BankList getBanks()

Gets the bank list resulting from a search.

Returns:

the bank list

Throws:

IllegalStateException - the bank list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getBankQueryInspector

BankQueryInspector getBankQueryInspector()

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.

getBankSearchResultsRecord

BankSearchResultsRecord getBankSearchResultsRecord(Type bankSearchRecordType)
                                            throws OperationFailedException

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

Parameters:

bankSearchRecordType - a bank search record type

Returns:

the bank search results record

Throws:

NullArgumentException - bankSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(bankSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.