OSID - osid.course.syllabus.ModuleSmartCourseCatalogSession Service Interface Definition

Interface	osid.course.syllabus.ModuleSmartCourseCatalogSession
Implements	`osid.OsidSession`
Used By	`osid.course.syllabus.CourseSyllabusManager`
Used By	`osid.course.syllabus.CourseSyllabusProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `ModuleQuery` can be retrieved from this session and mapped to this `CourseCatalog` to create a virtual collection of `Modules`. The docetsmay be sequenced using the `ModuleSearchOrder` from this session. This `CourseCatalog` has a default query that matches any module and a default search order that specifies no sequencing. The queries may be examined using a `ModuleQueryInspector`. The query may be modified by converting the inspector back to a `ModuleQuery` .
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	getModuleQuery
Description	Gets a module query.
Return	`osid.course.syllabus.ModuleQuery`		the module query
Compliance	`mandatory`		This method must be implemented.
Method	getModuleSearchOrder
Description	Gets a module search order.
Return	`osid.course.syllabus.ModuleSearchOrder`		the module search order
Compliance	`mandatory`		This method must be implemented.
Method	applyModuleQuery
Description	Applies a module query to this course catalog.
Parameters	`osid.course.syllabus.ModuleQuery`	`moduleQuery`	the module query
Errors	NULL_ARGUMENT		`moduleQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`moduleQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectModuleQuery
Description	Gets a module query inspector for this course catalog.
Return	`osid.course.syllabus.ModuleQueryInspector`		the module query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyModuleSequencing
Description	Applies a module search order to this course catalog.
Parameters	`osid.course.syllabus.ModuleSearchOrder`	`moduleSearchOrder`	the module search order
Errors	NULL_ARGUMENT		`moduleSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`moduleSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getModuleQueryFromInspector
Description	Gets a module query from an inspector.
Parameters	`osid.course.syllabus.ModuleQueryInspector`	`moduleQueryInspector`	a query inspector
Return	`osid.course.syllabus.ModuleQuery`		the module query
Errors	NULL_ARGUMENT		`moduleQueryInspector` is `null`
Errors	UNSUPPORTED		`moduleQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.