OSID Logo
OSID Specifications
learning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.learning.ObjectiveSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetObjectives
Description

Gets the objective list resulting from the search.

Returnosid.learning.ObjectiveListthe objective list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetObjectiveQueryInspector
Description

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

Returnosid.learning.ObjectiveQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetObjectiveSearchResultsRecord
Description

Gets the objective search results 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.ObjectiveSearchResultsRecordthe objective search results record
ErrorsNULL_ARGUMENT objectiveSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasSearchRecordType(objectiveSearchRecordType) is false
CompliancemandatoryThis method must be implemented.