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

Interface	osid.course.syllabus.DocetSmartCourseCatalogSession
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 `DocetQuery` can be retrieved from this session and mapped to this `CourseCatalog` to create a virtual collection of `Docets`. The docets may be sequenced using the `DocetSearchOrder` from this session. This `CourseCatalog` has a default query that matches any docet and a default search order that specifies no sequencing. The queries may be examined using a `DocetQueryInspector`. The query may be modified by converting the inspector back to a `DocetQuery`.
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	getDocetQuery
Description	Gets a docet query.
Return	`osid.course.syllabus.DocetQuery`		the docet query
Compliance	`mandatory`		This method must be implemented.
Method	getDocetSearchOrder
Description	Gets a docet search order.
Return	`osid.course.syllabus.DocetSearchOrder`		the docet search order
Compliance	`mandatory`		This method must be implemented.
Method	applyDocetQuery
Description	Applies a docet query to this course catalog.
Parameters	`osid.course.syllabus.DocetQuery`	`docetQuery`	the docet query
Errors	NULL_ARGUMENT		`docetQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`docetQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectDocetQuery
Description	Gets a docet query inspector for this course catalog.
Return	`osid.course.syllabus.DocetQueryInspector`		the docet query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyDocetSequencing
Description	Applies a docet search order to this course catalog.
Parameters	`osid.course.syllabus.DocetSearchOrder`	`docetSearchOrder`	the docet search order
Errors	NULL_ARGUMENT		`docetSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`docetSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getDocetQueryFromInspector
Description	Gets a docet query from an inspector.
Parameters	`osid.course.syllabus.DocetQueryInspector`	`docetQueryInspector`	a query inspector
Return	`osid.course.syllabus.DocetQuery`		the docet query
Errors	NULL_ARGUMENT		`docetQueryInspector` is `null`
Errors	UNSUPPORTED		`docetQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.