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

Interface	osid.course.registration.RegistrationTargetSmartCourseCatalogSession
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 `RegistrationTarget` Query can be retrieved from this session and mapped to this `CourseCatalog` to create a virtual collection of `RegistrationTar` gets. The registration targets may be sequenced using the `RegistrationTargetSearch` Order from this session. This `CourseCatalog` has a default query that matches any registration target and a default search order that specifies no sequencing. The queries may be examined using a `RegistrationTargetQueryInspe` ctor. The query may be modified by converting the inspector back to a `RegistrationTargetQuery` .
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	getRegistrationTargetQuery
Description	Gets a registration target query.
Return	`osid.course.registration.RegistrationTargetQuery`		the registration target query
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationTargetSearchOrder
Description	Gets a registration target search order.
Return	`osid.course.registration.RegistrationTargetSearchOrder`		the registration target search order
Compliance	`mandatory`		This method must be implemented.
Method	applyRegistrationTargetQuery
Description	Applies a registration target query to this course catalog.
Parameters	`osid.course.registration.RegistrationTargetQuery`	`registrationTargetQuery`	the registration target query
Errors	NULL_ARGUMENT		`registrationTargetQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`registrationTargetQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectRegistrationTargetQuery
Description	Gets a registration target query inspector for this course catalog.
Return	`osid.course.registration.RegistrationTargetQueryInspector`		the registration target query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyRegistrationTargetSequencing
Description	Applies a registration target search order to this course catalog.
Parameters	`osid.course.registration.RegistrationTargetSearchOrder`	`registrationTargetSearchOrder`	the registration target search order
Errors	NULL_ARGUMENT		`registrationTargetSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`registrationTargetSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationTargetQueryFromInspector
Description	Gets a registration target query from an inspector.
Parameters	`osid.course.registration.RegistrationTargetQueryInspector`	`registrationTargetQueryInspector`	a registration target query inspector
Return	`osid.course.registration.RegistrationTargetQuery`		the registration target query
Errors	NULL_ARGUMENT		`registrationTargetQueryInspector` is `null`
Errors	UNSUPPORTED		`registrationTargetQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.