OSID - osid.course.registration.CourseRegistrationSmartCourseCatalogSession Service Interface Definition

Interface	osid.course.registration.CourseRegistrationSmartCourseCatalogSession
Implements	`osid.OsidSession`
Used By	`osid.course.registration.CourseRegistrationManager`
Used By	`osid.course.registration.CourseRegistrationProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `CourseRegistration` Query can be retrieved from this session and mapped to this `CourseCatalog` to create a virtual collection of `CourseRegistrat` ions. The course registrations may be sequenced using the `CourseRegistrationSearch` Order from this session. This `CourseCatalog` has a default query that matches any course registration and a default search order that specifies no sequencing. The queries may be examined using a `CourseRegistrationQueryInspe` ctor. The query may be modified by converting the inspector back to a `CourseRegistrationQuery` .
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 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	getCourseRegistrationQuery
Description	Gets a course registration query.
Return	`osid.course.registration.CourseRegistrationQuery`		the course registration query
Compliance	`mandatory`		This method must be implemented.
Method	getCourseRegistrationSearchOrder
Description	Gets a course registration search order.
Return	`osid.course.registration.CourseRegistrationSearchOrder`		the course registration search order
Compliance	`mandatory`		This method must be implemented.
Method	applyCourseRegistrationQuery
Description	Applies a course registration query to this course catalog.
Parameters	`osid.course.registration.CourseRegistrationQuery`	`courseRegistrationQuery`	the course registration query
Errors	NULL_ARGUMENT		`courseRegistrationQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`courseRegistrationQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectCourseRegistrationQuery
Description	Gets a course registration query inspector for this course catalog.
Return	`osid.course.registration.CourseRegistrationQueryInspector`		the course registration query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyCourseRegistrationSequencing
Description	Applies a course registration search order to this course catalog.
Parameters	`osid.course.registration.CourseRegistrationSearchOrder`	`courseRegistrationSearchOrder`	the course registration search order
Errors	NULL_ARGUMENT		`courseRegistrationSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`courseRegistrationSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCourseRegistrationQueryFromInspector
Description	Gets a course registration query from an inspector.
Parameters	`osid.course.registration.CourseRegistrationQueryInspector`	`courseRegistrationQueryInspector`	a course registration query inspector
Return	`osid.course.registration.CourseRegistrationQuery`		the course registration query
Errors	NULL_ARGUMENT		`courseRegistrationQueryInspector` is `null`
Errors	UNSUPPORTED		`courseRegistrationQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.