org.osid.assessment

Interface BankSearchSession

All Superinterfaces:

java.lang.AutoCloseable, BankQuerySession, java.io.Closeable, 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

Methods

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.

Methods inherited from interface org.osid.assessment.BankQuerySession

canSearchBanks, getBankQuery, getBanksByQuery

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.