OSID Logo
OSID Specifications
course plan package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.plan.LessonSearchSession
Implementsosid.course.plan.LessonQuerySession
Description

This session provides methods for searching Lesson objects. The search query is constructed using the LessonQuery. The lesson record Type also specifies the record for the lesson query.

getLessonsByQuery() is the basic search method and returns a list of Lesson elements. A more advanced search may be performed with getLessonsBySearch(). It accepts a LessonSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getLessonsBySearch() returns a LessonSearchResults that can be used to access the resulting LessonList or be used to perform a search within the result set through LessonSearch.

Lessons may have a query record indicated by their respective record types. The query record is accessed via the LessonQuery. The returns in this session may not be cast directly to these interfaces.

MethodgetLessonSearch
Description

Gets a lesson search.

Returnosid.course.plan.LessonSearchthe lesson search
CompliancemandatoryThis method must be implemented.
MethodgetLessonSearchOrder
Description

Gets a lesson search order. The LessonSearchOrder is supplied to a LessonSearch to specify the ordering of results.

Returnosid.course.plan.LessonSearchOrderthe lesson search order
CompliancemandatoryThis method must be implemented.
MethodgetLessonsBySearch
Description

Gets the search results matching the given search.

Parametersosid.course.plan.LessonQuerylessonQuerythe lesson query
osid.course.plan.LessonSearchlessonSearchthe lesson search
Returnosid.course.plan.LessonSearchResultsthe lesson search results
ErrorsNULL_ARGUMENT lessonQuery or lessonSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED lessonQuery or lessonSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetLessonQueryFromInspector
Description

Gets a lesson query from an inspector. The inspector is available from a LessonSearchResults.

Parametersosid.course.plan.LessonQueryInspectorlessonQueryInspectora lesson query inspector
Returnosid.course.plan.LessonQuerythe course catalog query
ErrorsNULL_ARGUMENT lessonQueryInspector is null
UNSUPPORTED lessonQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.