OSID - osid.course.plan.LessonSearchSession Service Interface Definition

Interface	osid.course.plan.LessonSearchSession
Implements	`osid.course.plan.LessonQuerySession`
Used By	`osid.course.plan.CoursePlanManager`
Used By	`osid.course.plan.CoursePlanProxyManager`
Description	This session provides methods for searching `Lessons` . 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.
Method	getLessonSearch
Description	Gets a lesson search.
Return	`osid.course.plan.LessonSearch`		the lesson search
Compliance	`mandatory`		This method must be implemented.
Method	getLessonSearchOrder
Description	Gets a lesson search order. The `LessonSearchOrder` is supplied to a `LessonSearch` to specify the ordering of results.
Return	`osid.course.plan.LessonSearchOrder`		the lesson search order
Compliance	`mandatory`		This method must be implemented.
Method	getLessonsBySearch
Description	Gets the search results matching the given search.
Parameters	`osid.course.plan.LessonQuery`	`lessonQuery`	the lesson query
Parameters	`osid.course.plan.LessonSearch`	`lessonSearch`	the lesson search
Return	`osid.course.plan.LessonSearchResults`		the lesson search results
Errors	NULL_ARGUMENT		`lessonQuery` or `lessonSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`lessonQuery` or `lessonSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getLessonQueryFromInspector
Description	Gets a lesson query from an inspector. The inspector is available from a `LessonSearchResults` .
Parameters	`osid.course.plan.LessonQueryInspector`	`lessonQueryInspector`	a lesson query inspector
Return	`osid.course.plan.LessonQuery`		the course catalog query
Errors	NULL_ARGUMENT		`lessonQueryInspector` is `null`
Errors	UNSUPPORTED		`lessonQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.