OSID Logo
OSID Specifications
assessment package
Version 3.1.0
Interfaceosid.assessment.BankSearchSession
Implementsosid.assessment.BankQuerySession
Used Byosid.assessment.AssessmentManager
osid.assessment.AssessmentProxyManager
Description

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.

MethodgetBankSearch
Description

Gets a bank search.

Returnosid.assessment.BankSearch a bank search
Compliancemandatory This method must be implemented.
MethodgetBankSearchOrder
Description

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

Returnosid.assessment.BankSearchOrder the bank search order
Compliancemandatory This method must be implemented.
MethodgetBanksBySearch
Description

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

Parametersosid.assessment.BankQuerybankQuery the bank query
osid.assessment.BankSearchbankSearch the bank search
Returnosid.assessment.BankSearchResults the bank search results
ErrorsNULL_ARGUMENT bankQuery or bankSearch is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED bankQuery or bankSearch is not of this service
Compliancemandatory This method must be implemented.
MethodgetBankQueryFromInspector
Description

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

Parametersosid.assessment.BankQueryInspectorbankQueryInspector a bank query inspector
Returnosid.assessment.BankQuery the bank query
ErrorsNULL_ARGUMENT bankQueryInspector is null
UNSUPPORTED bankQueryInspector is not of this service
Compliancemandatory This method must be implemented.