OSID - osid.course.CourseSmartCourseCatalogSession Service Interface Definition

Interface	osid.course.CourseSmartCourseCatalogSession
Implements	`osid.OsidSession`
Used By	`osid.course.CourseManager`
Used By	`osid.course.CourseProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `CourseQuery` can be retrieved from this session and mapped to this `CourseCatalog` to create a virtual collection of `Courses`. The courses may be sequenced using the `CourseSearchOrder` from this session. This `CourseCatalog` has a default query that matches any course and a default search order that specifies no sequencing. The queries may be examined using a `CourseQueryInspector`. The query may be modified by converting the inspector back to a `CourseQuery` .
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 course catalog
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 assessment. 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	getCourseQuery
Description	Gets a course query.
Return	`osid.course.CourseQuery`		the course query
Compliance	`mandatory`		This method must be implemented.
Method	getCourseSearchOrder
Description	Gets a course search order.
Return	`osid.course.CourseSearchOrder`		the course search order
Compliance	`mandatory`		This method must be implemented.
Method	applyCourseQuery
Description	Applies a course query to this course catalog.
Parameters	`osid.course.CourseQuery`	`courseQuery`	the course query
Errors	NULL_ARGUMENT		`courseQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`courseQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectCourseQuery
Description	Gets a course query inspector for this course catalog.
Return	`osid.course.CourseQueryInspector`		the course query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyCourseSequencing
Description	Applies a course search order to this course catalog.
Parameters	`osid.course.CourseSearchOrder`	`courseSearchOrder`	the course search order
Errors	NULL_ARGUMENT		`courseSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`courseSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCourseQueryFromInspector
Description	Gets a course query from an inspector.
Parameters	`osid.course.CourseQueryInspector`	`courseQueryInspector`	a query inspector
Return	`osid.course.CourseQuery`		the course query
Errors	NULL_ARGUMENT		`courseQueryInspector` is `null`
Errors	UNSUPPORTED		`courseQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.