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

Interface	osid.course.registration.ActivityRegistrationSmartCourseCatalogSession
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. An `ActivityRegistrationQuery` can be retrieved from this session and mapped to this `CoursOfferingeCatalog` to create a virtual collection of `ActivityRegistrations` . The activity registrations may be sequenced using the `ActivityRegistrationSearchOrder` from this session. This `CourseCatalog` has a default query that matches any activity registration and a default search order that specifies no sequencing. The queries may be examined using an `ActivityRegistrationQueryInspector` . The query may be modified by converting the inspector back to an `ActivityRegistrationQuery` .
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	getActivityRegistrationQuery
Description	Gets an activity registration query.
Return	`osid.course.registration.ActivityRegistrationQuery`		the activity registration query
Compliance	`mandatory`		This method must be implemented.
Method	getActivityRegistrationSearchOrder
Description	Gets an activity registration search order.
Return	`osid.course.registration.ActivityRegistrationSearchOrder`		the activity registration search order
Compliance	`mandatory`		This method must be implemented.
Method	applyActivityRegistrationQuery
Description	Applies an activity registration query to this course catalog.
Parameters	`osid.course.registration.ActivityRegistrationQuery`	`activityRegistrationQuery`	the activity registration query
Errors	NULL_ARGUMENT		`activityRegistrationQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`activityRegistrationQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectActivityRegistrationQuery
Description	Gets an activity registration query inspector for this course catalog.
Return	`osid.course.registration.ActivityRegistrationQueryInspector`		the activity registration query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyActivityRegistrationSequencing
Description	Applies an activity registration search order to this course catalog.
Parameters	`osid.course.registration.ActivityRegistrationSearchOrder`	`activityRegistrationSearchOrder`	the activity registration search order
Errors	NULL_ARGUMENT		`activityRegistrationSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`activityRegistrationSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getActivityRegistrationQueryFromInspector
Description	Gets an activity registration query from an inspector.
Parameters	`osid.course.registration.ActivityRegistrationQueryInspector`	`activityRegistrationQueryInspector`	a query inspector
Return	`osid.course.registration.ActivityRegistrationQuery`		the activity registration query
Errors	NULL_ARGUMENT		`activityRegistrationQueryInspector` is `null`
Errors	UNSUPPORTED		`activityRegistrationQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.