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

Interface	osid.course.plan.LessonSmartCourseCatalogSession
Implements	`osid.OsidSession`
Used By	`osid.course.plan.CoursePlanManager`
Used By	`osid.course.plan.CoursePlanProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `LessonQuery` can be retrieved from this session and mapped to this `CourseCatalog` to create a virtual collection of `Lessons`. The lessonsmay be sequenced using the `LessonSearchOrder` from this session. This `CourseCatalog` has a default query that matches any lesson and a default search order that specifies no sequencing. The queries may be examined using a `LessonQueryInspector`. The query may be modified by converting the inspector back to a `LessonQuery` .
Method	getCourseCatalogId
Description	Gets the `CourseCatalog` `Id` associated with this session.
Return	`osid.id.Id`		the `CourseCatalog Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCourseCatalog
Description	Gets the `CourseCatalog` associated with this session.
Return	`osid.course.CourseCatalog`		the `CourseCatalog` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSmartCourseCatalogs
Description	Tests if this user can manage smart course catalogs. A return of true does not guarantee successful authorization. A return of false indicates that it is known methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer operations to unauthorized users.
Return	`boolean`		`false` if smart course catalog management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getLessonQuery
Description	Gets a lesson query.
Return	`osid.course.plan.LessonQuery`		the lesson query
Compliance	`mandatory`		This method must be implemented.
Method	getLessonSearchOrder
Description	Gets a lesson search order.
Return	`osid.course.plan.LessonSearchOrder`		the lesson search order
Compliance	`mandatory`		This method must be implemented.
Method	applyLessonQuery
Description	Applies a lesson query to this course catalog.
Parameters	`osid.course.plan.LessonQuery`	`lessonQuery`	the lesson query
Errors	NULL_ARGUMENT		`lessonQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`lessonQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectLessonQuery
Description	Gets a lesson query inspector for this course catalog.
Return	`osid.course.plan.LessonQueryInspector`		the lesson query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyLessonSequencing
Description	Applies a lesson search order to this course catalog.
Parameters	`osid.course.plan.LessonSearchOrder`	`lessonSearchOrder`	the lesson search order
Errors	NULL_ARGUMENT		`lessonSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`lessonSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getLessonQueryFromInspector
Description	Gets a lesson query from an inspector.
Parameters	`osid.course.plan.LessonQueryInspector`	`lessonQueryInspector`	a query inspector
Return	`osid.course.plan.LessonQuery`		the lesson query
Errors	NULL_ARGUMENT		`lessonQueryInspector` is `null`
Errors	UNSUPPORTED		`lessonQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.