Interface BankSearchSession

All Superinterfaces:

AutoCloseable, BankQuerySession, Closeable, OsidSession, OsidSession

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.

Method Summary

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

Methods inherited from interface BankQuerySession

canSearchBanks, getBankQuery, getBanksByQuery

Modifier and Type	Method	Description
boolean	canSearchBanks()	Tests if this user can perform Bank searches.
BankQuery	getBankQuery()	Gets a bank query.
BankList	getBanksByQuery(BankQuery bankQuery)	Gets a list of Bank objects matching the given bank query.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getBankSearch

BankSearch getBankSearch()

Gets a bank search.

Returns:

a bank search

Compliance:

mandatory - This method must be implemented.

getBankSearchOrder

BankSearchOrder getBankSearchOrder()

Gets a bank search order. The BankSearchOrder is supplied to a BankSearch to specify the ordering of results.

Returns:

the bank search order

Compliance:

mandatory - This method must be implemented.

getBanksBySearch

BankSearchResults getBanksBySearch(BankQuery bankQuery,
 BankSearch bankSearch)
                            throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

bankQuery - the bank query

bankSearch - the bank search

Returns:

the bank search results

Throws:

NullArgumentException - bankQuery or bankSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - bankQuery or bankSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getBankQueryFromInspector

BankQuery getBankQueryFromInspector(BankQueryInspector bankQueryInspector)

Gets a bank query from an inspector. The inspector is available from a BankSearchResults.

Parameters:

bankQueryInspector - a bank query inspector

Returns:

the bank query

Throws:

NullArgumentException - bankQueryInspector is null

UnsupportedException - bankQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.