Interface BankSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface BankSearch
extends OsidSearch

The interface for governing bank searches.

Method Summary

Modifier and Type	Method	Description
BankSearchRecord	getBankSearchRecord(Type bankSearchRecordType)	Gets the bank search record corresponding to the given bank search record Type.
void	orderBankResults(BankSearchOrder bankSearchOrder)	Specify an ordering to the search results.
void	searchAmongBanks(IdList bankIds)	Execute this search among the given list of banks.

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

searchAmongBanks

void searchAmongBanks(IdList bankIds)

Execute this search among the given list of banks.

Parameters:

bankIds - list of banks

Throws:

NullArgumentException - bankIds is null

Compliance:

mandatory - This method must be implemented.

orderBankResults

void orderBankResults(BankSearchOrder bankSearchOrder)

Specify an ordering to the search results.

Parameters:

bankSearchOrder - bank search order

Throws:

NullArgumentException - bankSearchOrder is null

UnsupportedException - bankSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getBankSearchRecord

BankSearchRecord getBankSearchRecord(Type bankSearchRecordType)
                              throws OperationFailedException

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

Throws:

NullArgumentException - bankSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(bankSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.