OSID - osid.course.CourseOfferingSmartCourseCatalogSession Service Interface Definition

Interface	osid.course.CourseOfferingSmartCourseCatalogSession
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 `CourseOfferingQuery` can be retrieved from this session and mapped to this `CoursOfferingeCatalog` to create a virtual collection of `CourseOfferings`. The course offerings may be sequenced using the `CourseOfferingSearchOrder` from this session. This `CourseCatalog` has a default query that matches any course offering and a default search order that specifies no sequencing. The queries may be examined using a `CourseOfferingQueryInspector`. The query may be modified by converting the inspector back to a `CourseOfferingQuery`.
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	getCourseOfferingQuery
Description	Gets a course offering query.
Return	`osid.course.CourseOfferingQuery`		the course offering query
Compliance	`mandatory`		This method must be implemented.
Method	getCourseOfferingSearchOrder
Description	Gets a course offering search order.
Return	`osid.course.CourseOfferingSearchOrder`		the course offering search order
Compliance	`mandatory`		This method must be implemented.
Method	applyCourseOfferingQuery
Description	Applies a course offering query to this course catalog.
Parameters	`osid.course.CourseOfferingQuery`	`courseOfferingQuery`	the course offering query
Errors	NULL_ARGUMENT		`courseOfferingQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`courseOfferingQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectCourseOfferingQuery
Description	Gets a course offering query inspector for this course catalog.
Return	`osid.course.CourseOfferingQueryInspector`		the course offering query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyCourseOfferingSequencing
Description	Applies a course offering search order to this course catalog.
Parameters	`osid.course.CourseOfferingSearchOrder`	`courseOfferingSearchOrder`	the course offering search order
Errors	NULL_ARGUMENT		`courseOfferingSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`courseOfferingSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCourseOfferingQueryFromInspector
Description	Gets a course offering query from an inspector.
Parameters	`osid.course.CourseOfferingQueryInspector`	`courseOfferingQueryInspector`	a query inspector
Return	`osid.course.CourseOfferingQuery`		the course offering query
Errors	NULL_ARGUMENT		`courseOfferingQueryInspector` is `null`
Errors	UNSUPPORTED		`courseOfferingQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.