OSID Logo
OSID Specifications
course plan package
Version 3.1.0
Interfaceosid.course.plan.LessonSearch
Implementsosid.OsidSearch
Used Byosid.course.plan.LessonSearchSession
Description

The search interface for governing lesson searches.

MethodsearchAmongLessons
Description

Execute this search among the given list of lessons.

Parametersosid.id.IdListlessonIds list of lessons
ErrorsNULL_ARGUMENT lessonIds is null
Compliancemandatory This method must be implemented.
MethodorderLessonResults
Description

Specify an ordering to the search results.

Parametersosid.course.plan.LessonSearchOrderlessonSearchOrder lesson search order
ErrorsNULL_ARGUMENT lessonSearchOrder is null
UNSUPPORTED lessonSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetLessonSearchRecord
Description

Gets the lesson search 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.LessonSearchRecord the lesson search record
ErrorsNULL_ARGUMENT lessonSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(lessonSearchRecordType) is false
Compliancemandatory This method must be implemented.