OSID Logo
OSID Specifications
course plan package
Version 3.1.0
Interfaceosid.course.plan.LessonSearchResults
Implementsosid.OsidSearchResults
Used Byosid.course.plan.LessonSearchSession
Description

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

MethodgetLessons
Description

Gets the lesson list resulting from a search.

Returnosid.course.plan.LessonList the lesson list
ErrorsILLEGAL_STATE list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetLessonQueryInspector
Description

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

Returnosid.course.plan.LessonQueryInspector the query inspector
Compliancemandatory This method must be implemented.
MethodgetLessonSearchResultsRecord
Description

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

Parametersosid.type.TypelessonSearchRecordType a lesson search record type
Returnosid.course.plan.records.LessonSearchResultsRecord the lesson search results record
ErrorsNULL_ARGUMENT LessonSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(lessonSearchRecordType) is false
Compliancemandatory This method must be implemented.