org.osid.assessment

Interface BankQuerySession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

All Known Subinterfaces:

BankSearchSession

public interface BankQuerySession
extends OsidSession

This session provides methods for searching among Bank objects. The search query is constructed using the BankQuery.

Banks may have aquery record indicated by their respective record types. The query record is accessed via the BankQuery.

Method Summary

Methods

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

canSearchBanks

boolean canSearchBanks()

Tests if this user can perform Bank searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer search operations to unauthorized users.

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getBankQuery

BankQuery getBankQuery()

Gets a bank query.

Returns:

a bank query

Compliance:

mandatory - This method must be implemented.

getBanksByQuery

BankList getBanksByQuery(BankQuery bankQuery)
                         throws OperationFailedException,
                                PermissionDeniedException

Gets a list of Bank objects matching the given bank query.

Parameters:

bankQuery - the bank query

Returns:

the returned BankList

Throws:

NullArgumentException - bankQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - bankQuery is not of this service

Compliance:

mandatory - This method must be implemented.