OSID Logo
OSID Specifications
assessment package
Version 3.0.0
Release Candidate Preview
Interfaceosid.assessment.BankSearchResults
Implementsosid.OsidSearchResults
Description

This interface provides a means to capture results of a search.

MethodgetBanks
Description

Gets the bank list resulting from a search.

Returnosid.assessment.BankListthe bank list
ErrorsILLEGAL_STATEthe bank list has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetBankQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.assessment.BankQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetBankSearchResultsRecord
Description

Gets the bank search results record corresponding to the given bank search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypebankSearchRecordTypea bank search record type
Returnosid.assessment.records.BankSearchResultsRecordthe bank search results record
ErrorsNULL_ARGUMENT bankSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(bankSearchRecordType) is false
CompliancemandatoryThis method must be implemented.