OSID - osid.course.ActivityUnitSmartCourseCatalogSession Service Interface Definition

Interface	osid.course.ActivityUnitSmartCourseCatalogSession
Implements	`osid.OsidSession`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. An `ActivityUnitQuery` can be retrieved from this session and mapped to this `CoursOfferingeCatalog` to create a virtual collection of `ActivityUnits.` The activity units may be sequenced using the `ActivityUnitSearchOrder` from this session. This `CourseCatalog` has a default query that matches any activity unit and a default search order that specifies no sequencing. The queries may be examined using an `ActivityUnitQueryInspector.` The query may be modified by converting the inspector back to an `ActivityUnitQuery.`
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	getActivityUnitQuery
Description	Gets an activity unit query.
Return	`osid.course.ActivityUnitQuery`		the activity unit query
Compliance	`mandatory`		This method must be implemented.
Method	getActivityUnitSearchOrder
Description	Gets an activity unit search order.
Return	`osid.course.ActivityUnitSearchOrder`		the activity unit search order
Compliance	`mandatory`		This method must be implemented.
Method	applyActivityUnitQuery
Description	Applies an activity unit query to this course catalog.
Parameters	`osid.course.ActivityUnitQuery`	`activityUnitQuery`	the activity unit query
Errors	NULL_ARGUMENT		`activityUnitQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`activityUnitQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectActivityUnitQuery
Description	Gets an activity unit query inspector for this course catalog.
Return	`osid.course.ActivityUnitQueryInspector`		the activity unit query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyActivityUnitSequencing
Description	Applies an activity unit search order to this course catalog.
Parameters	`osid.course.ActivityUnitSearchOrder`	`activityUnitSearchOrder`	the activity unit search order
Errors	NULL_ARGUMENT		`activityUnitSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`activityUnitSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getActivityUnitQueryFromInspector
Description	Gets an activity unit query from an inspector.
Parameters	`osid.course.ActivityUnitQueryInspector`	`activityUnitQueryInspector`	a query inspector
Return	`osid.course.ActivityUnitQuery`		the activity unit query
Errors	NULL_ARGUMENT		`activityUnitQueryInspector` is `null`
Errors	UNSUPPORTED		`activityUnitQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.