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

Interface	osid.course.registration.RegistrationSmartCourseCatalogSession
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 `RegistrationQuery` can be retrieved from this session and mapped to this `CoursOfferingeCatalog` to create a virtual collection of `Registrations`. The registrations may be sequenced using the `RegistrationSearchOrder` from this session. This `CourseCatalog` has a default query that matches any registration and a default search order that specifies no sequencing. The queries may be examined using a `RegistrationQueryInspector`. The query may be modified by converting the inspector back to a `RegistrationQuery`.
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	getRegistrationQuery
Description	Gets a registration query.
Return	`osid.course.registration.RegistrationQuery`		the registration query
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationSearchOrder
Description	Gets a registration search order.
Return	`osid.course.registration.RegistrationSearchOrder`		the registration search order
Compliance	`mandatory`		This method must be implemented.
Method	applyRegistrationQuery
Description	Applies a registration query to this course catalog.
Parameters	`osid.course.registration.RegistrationQuery`	`registrationQuery`	the registration query
Errors	NULL_ARGUMENT		`registrationQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`registrationQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectRegistrationQuery
Description	Gets a registration query inspector for this course catalog.
Return	`osid.course.registration.RegistrationQueryInspector`		the registration query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyRegistrationSequencing
Description	Applies a registration search order to this course catalog.
Parameters	`osid.course.registration.RegistrationSearchOrder`	`registrationSearchOrder`	the registration search order
Errors	NULL_ARGUMENT		`registrationSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`registrationSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationQueryFromInspector
Description	Gets a registration query from an inspector.
Parameters	`osid.course.registration.RegistrationQueryInspector`	`registrationQueryInspector`	a query inspector
Return	`osid.course.registration.RegistrationQuery`		the registration query
Errors	NULL_ARGUMENT		`registrationQueryInspector` is `null`
Errors	UNSUPPORTED		`registrationQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.