OSID Logo
OSID Specifications
assessment package
Version 3.0.0
Release Candidate Preview
Interfaceosid.assessment.BankSearch
Implementsosid.OsidSearch
Description

The interface for governing bank searches.

MethodsearchAmongBanks
Description

Execute this search among the given list of banks.

Parametersosid.id.IdListbankIdslist of banks
ErrorsNULL_ARGUMENT bankIds is null
CompliancemandatoryThis method must be implemented.
MethodorderBankResults
Description

Specify an ordering to the search results.

Parametersosid.assessment.BankSearchOrderbankSearchOrderbank search order
ErrorsNULL_ARGUMENT bankSearchOrder is null
UNSUPPORTED bankSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetBankSearchRecord
Description

Gets the bank search 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.BankSearchRecordthe bank search record
ErrorsNULL_ARGUMENT bankSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(bankSearchRecordType) is false
CompliancemandatoryThis method must be implemented.