OSID Logo
OSID Specifications
course plan package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.plan.LessonSearchResults
Implementsosid.OsidSearchResults
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.LessonListthe lesson list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetLessonQueryInspector
Description

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

Returnosid.course.plan.LessonQueryInspectorthe query inspector
CompliancemandatoryThis 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.TypelessonSearchRecordTypea lesson search record type
Returnosid.course.plan.records.LessonSearchResultsRecordthe lesson search results record
ErrorsNULL_ARGUMENT LessonSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(lessonSearchRecordType) is false
CompliancemandatoryThis method must be implemented.