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

Interface	osid.course.syllabus.SyllabusSmartCourseCatalogSession
Implements	`osid.OsidSession`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `SyllabusQuery` can be retrieved from this session and mapped to this `CourseCatalog` to create a virtual collection of `Syllabi.` The docetsmay be sequenced using the `SyllabusSearchOrder` from this session. This `CourseCatalog` has a default query that matches any syllabus and a default search order that specifies no sequencing. The queries may be examined using a `SyllabusQueryInspector.` The query may be modified by converting the inspector back to a `SyllabusQuery.`
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	getSyllabusQuery
Description	Gets a syllabus query.
Return	`osid.course.syllabus.SyllabusQuery`		the syllabus query
Compliance	`mandatory`		This method must be implemented.
Method	getSyllabusSearchOrder
Description	Gets a syllabus search order.
Return	`osid.course.syllabus.SyllabusSearchOrder`		the syllabus search order
Compliance	`mandatory`		This method must be implemented.
Method	applySyllabusQuery
Description	Applies a syllabus query to this course catalog.
Parameters	`osid.course.syllabus.SyllabusQuery`	`syllabusQuery`	the syllabus query
Errors	NULL_ARGUMENT		`syllabusQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`syllabusQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectSyllabusQuery
Description	Gets a syllabus query inspector for this course catalog.
Return	`osid.course.syllabus.SyllabusQueryInspector`		the syllabus query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applySyllabusSequencing
Description	Applies a syllabus search order to this course catalog.
Parameters	`osid.course.syllabus.SyllabusSearchOrder`	`syllabusSearchOrder`	the syllabus search order
Errors	NULL_ARGUMENT		`syllabusSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`syllabusSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getSyllabusQueryFromInspector
Description	Gets a syllabus query from an inspector.
Parameters	`osid.course.syllabus.SyllabusQueryInspector`	`syllabusQueryInspector`	a query inspector
Return	`osid.course.syllabus.SyllabusQuery`		the syllabus query
Errors	NULL_ARGUMENT		`syllabusQueryInspector` is `null`
Errors	UNSUPPORTED		`syllabusQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.