OSID Logo
OSID Specifications
course plan package
Version 3.0.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.IdListlessonIdslist of lessons
ErrorsNULL_ARGUMENTlessonIds is null
CompliancemandatoryThis method must be implemented.
MethodorderLessonResults
Description

Specify an ordering to the search results.

Parametersosid.course.plan.LessonSearchOrderlessonSearchOrderlesson search order
ErrorsNULL_ARGUMENTlessonSearchOrder is null
UNSUPPORTEDlessonSearchOrder is not of this service
CompliancemandatoryThis 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.TypelessonSearchRecordTypea lesson search record type
Returnosid.course.plan.records.LessonSearchRecordthe lesson search record
ErrorsNULL_ARGUMENTlessonSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(lessonSearchRecordType) is false
CompliancemandatoryThis method must be implemented.