OSID Logo
OSID Specifications
assessment package
Version 3.0.0
Release Candidate Preview
Interfaceosid.assessment.BankQuerySession
Implementsosid.OsidSession
Description

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.

MethodcanSearchBanks
Description

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.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetBankQuery
Description

Gets a bank query.

Returnosid.assessment.BankQuerya bank query
CompliancemandatoryThis method must be implemented.
MethodgetBanksByQuery
Description

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

Parametersosid.assessment.BankQuerybankQuerythe bank query
Returnosid.assessment.BankListthe returned BankList
ErrorsNULL_ARGUMENT bankQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED bankQuery is not of this service
CompliancemandatoryThis method must be implemented.