public interface BankSearchSession extends BankQuerySession
This session provides methods for searching among Bank
objects. The search query is constructed using the BankQuery.
getBanksByQuery()
is the basic search method and
returns a list of Bank
objects.A more advanced search may
be performed with getBanksBySearch().
It accepts a
BankSearch
in addition to the query for the purpose of specifying
additional options affecting the entire search, such as ordering.
getBanksBySearch()
returns a BankSearchResults
that
can be used to access the resulting BankList
or be used to
perform a search within the result set through BankSearch.
Banks may have a query record indicated by their respective record
types. The query record is accessed via the BankQuery.
Modifier and Type | Method and Description |
---|---|
BankQuery |
getBankQueryFromInspector(BankQueryInspector bankQueryInspector)
Gets a bank query from an inspector.
|
BankSearchResults |
getBanksBySearch(BankQuery bankQuery,
BankSearch bankSearch)
Gets the search results matching the given search query using the
given search.
|
BankSearch |
getBankSearch()
Gets a bank search.
|
BankSearchOrder |
getBankSearchOrder()
Gets a bank search order.
|
canSearchBanks, getBankQuery, getBanksByQuery
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
BankSearch getBankSearch()
mandatory
- This method must be implemented. BankSearchOrder getBankSearchOrder()
BankSearchOrder
is
supplied to a BankSearch
to specify the ordering of
results.mandatory
- This method must be implemented. BankSearchResults getBanksBySearch(BankQuery bankQuery, BankSearch bankSearch) throws OperationFailedException, PermissionDeniedException
bankQuery
- the bank querybankSearch
- the bank searchNullArgumentException
- bankQuery
or
bankSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- bankQuery
or
bankSearch
is not of this servicemandatory
- This method must be implemented. BankQuery getBankQueryFromInspector(BankQueryInspector bankQueryInspector)
BankSearchResults.
bankQueryInspector
- a bank query inspectorNullArgumentException
- bankQueryInspector
is null
UnsupportedException
- bankQueryInspector
is not of this servicemandatory
- This method must be implemented.