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

ObjectiveSearch defines the interface for specifying objective search options.

MethodsearchAmongObjectives
Description

Execute this search among the given list of objectives.

Parametersosid.id.IdListobjectiveIdslist of objectives
ErrorsNULL_ARGUMENT objectiveIds is null
CompliancemandatoryThis method must be implemented.
MethodorderObjectiveResults
Description

Specify an ordering to the search results.

Parametersosid.learning.ObjectiveSearchOrderobjectiveSearchOrderobjective search order
ErrorsNULL_ARGUMENT objectiveSearchOrder is null
UNSUPPORTED objectiveSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetObjectiveSearchRecord
Description

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

Parametersosid.type.TypeobjectiveSearchRecordTypean objective search record type
Returnosid.learning.records.ObjectiveSearchRecordthe objective search record
ErrorsNULL_ARGUMENT objectiveSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasSearchRecordType(objectiveSearchRecordType) is false
CompliancemandatoryThis method must be implemented.