OSID - osid.course.plan.PlanSmartCourseCatalogSession Service Interface Definition

Interface	osid.course.plan.PlanSmartCourseCatalogSession
Implements	`osid.OsidSession`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `PlanQuery` can be retrieved from this session and mapped to this `CourseCatalog` to create a virtual collection of `Plans.` The lessonsmay be sequenced using the `PlanSearchOrder` from this session. This `CourseCatalog` has a default query that matches any plan and a default search order that specifies no sequencing. The queries may be examined using a `PlanQueryInspector.` The query may be modified by converting the inspector back to a `PlanQuery.`
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 `CourseCatalog` associated with this session
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	getPlanQuery
Description	Gets a plan query.
Return	`osid.course.plan.PlanQuery`		the plan query
Compliance	`mandatory`		This method must be implemented.
Method	getPlanSearchOrder
Description	Gets a plan search order.
Return	`osid.course.plan.PlanSearchOrder`		the plan search order
Compliance	`mandatory`		This method must be implemented.
Method	applyPlanQuery
Description	Applies a plan query to this course catalog.
Parameters	`osid.course.plan.PlanQuery`	`planQuery`	the plan query
Errors	NULL_ARGUMENT		`planQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`planQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectPlanQuery
Description	Gets a plan query inspector for this course catalog.
Return	`osid.course.plan.PlanQueryInspector`		the plan query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyPlanSequencing
Description	Applies a plan search order to this course catalog.
Parameters	`osid.course.plan.PlanSearchOrder`	`planSearchOrder`	the plan search order
Errors	NULL_ARGUMENT		`planSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`planSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getPlanQueryFromInspector
Description	Gets a plan query from an inspector.
Parameters	`osid.course.plan.PlanQueryInspector`	`planQueryInspector`	a query inspector
Return	`osid.course.plan.PlanQuery`		the plan query
Errors	NULL_ARGUMENT		`planQueryInspector` is `null`
Errors	UNSUPPORTED		`planQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.