OSID - osid.course.chronicle.CourseEntrySmartCourseCatalogSession Service Interface Definition

Interface	osid.course.chronicle.CourseEntrySmartCourseCatalogSession
Implements	`osid.OsidSession`
Used By	`osid.course.chronicle.CourseChronicleManager`
Used By	`osid.course.chronicle.CourseChronicleProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `CourseEntryQuery` can be retrieved from this session and mapped to this `CourseCatalog` to create a virtual collection of `CourseEntries`. The courses may be sequenced using the `CourseEntrySearchOrder` 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 `CourseEntryQueryInspector`. The query may be modified by converting the inspector back to a `CourseEntryQuery`.
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	getCourseEntryQuery
Description	Gets a course entry query.
Return	`osid.course.chronicle.CourseEntryQuery`		the course entry query
Compliance	`mandatory`		This method must be implemented.
Method	getCourseEntrySearchOrder
Description	Gets a course entry search order.
Return	`osid.course.chronicle.CourseEntrySearchOrder`		the course entry search order
Compliance	`mandatory`		This method must be implemented.
Method	applyCourseEntryQuery
Description	Applies a course entry query to this course catalog.
Parameters	`osid.course.chronicle.CourseEntryQuery`	`courseEntryQuery`	the course entry query
Errors	NULL_ARGUMENT		`courseEntryQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`courseEntryQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectCourseEntryQuery
Description	Gets a course entry query inspector for this course catalog.
Return	`osid.course.chronicle.CourseEntryQueryInspector`		the course entry query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyCourseEntrySequencing
Description	Applies a course entry search order to this course catalog.
Parameters	`osid.course.chronicle.CourseEntrySearchOrder`	`courseEntrySearchOrder`	the course entry search order
Errors	NULL_ARGUMENT		`courseEntrySearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`courseEntrySearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCourseEntryQueryFromInspector
Description	Gets a course entry query from an inspector.
Parameters	`osid.course.chronicle.CourseEntryQueryInspector`	`courseEntryQueryInspector`	a query inspector
Return	`osid.course.chronicle.CourseEntryQuery`		the course entry query
Errors	NULL_ARGUMENT		`courseEntryQueryInspector` is `null`
Errors	UNSUPPORTED		`courseEntryQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.