OSID Logo
OSID Specifications
learning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.learning.ObjectiveBankSearch
Implementsosid.OsidSearch
Description

The interface for governing objective bank searches.

MethodsearchAmongObjectiveBanks
Description

Execute this search among the given list of objective banks.

Parametersosid.id.IdListobjectiveBankIdslist of objective banks
ErrorsNULL_ARGUMENT objective bankIds is null
CompliancemandatoryThis method must be implemented.
MethodorderObjectiveBankResults
Description

Specify an ordering to the search results.

Parametersosid.learning.ObjectiveBankSearchOrderobjectiveBankSearchOrderobjective bank search order
ErrorsNULL_ARGUMENT objectiveBankSearchOrder is null
UNSUPPORTED objectiveBankSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetObjectiveBankSearchRecord
Description

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

Parametersosid.type.TypeobjectiveBankSearchRecordTypean objective bank search record type
Returnosid.learning.records.ObjectiveBankSearchRecordthe objective bank search record
ErrorsNULL_ARGUMENT objectiveBankSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasSearchRecordType(objective bankSearchRecordType) is false
CompliancemandatoryThis method must be implemented.