public interface BankSearch extends OsidSearch
The interface for governing bank searches.
Modifier and Type | Method and 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.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongBanks(IdList bankIds)
bankIds
- list of banksNullArgumentException
- bankIds
is
null
mandatory
- This method must be implemented. void orderBankResults(BankSearchOrder bankSearchOrder)
bankSearchOrder
- bank search orderNullArgumentException
- bankSearchOrder
is null
UnsupportedException
- bankSearchOrder
is not of this servicemandatory
- This method must be implemented. BankSearchRecord getBankSearchRecord(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.