OSID - osid.course.TermSmartCourseCatalogSession Service Interface Definition

Interface	osid.course.TermSmartCourseCatalogSession
Implements	`osid.OsidSession`
Used By	`osid.course.CourseManager`
Used By	`osid.course.CourseProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `TermQuery` can be retrieved from this session and mapped to this `CourseCatalog` to create a virtual collection of `Terms`. The terms may be sequenced using the `TermSearchOrder` from this session. This `CourseCatalog` has a default query that matches any term and a default search order that specifies no sequencing. The queries may be examined using a `TermQueryInspector`. The query may be modified by converting the inspector back to a `TermQuery`.
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	getTermQuery
Description	Gets a term query.
Return	`osid.course.TermQuery`		the term query
Compliance	`mandatory`		This method must be implemented.
Method	getTermSearchOrder
Description	Gets a term search order.
Return	`osid.course.TermSearchOrder`		the term search order
Compliance	`mandatory`		This method must be implemented.
Method	applyTermQuery
Description	Applies a term query to this course catalog.
Parameters	`osid.course.TermQuery`	`termQuery`	the term query
Errors	NULL_ARGUMENT		`termQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`termQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectTermQuery
Description	Gets a term query inspector for this course catalog.
Return	`osid.course.TermQueryInspector`		the term query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyTermSequencing
Description	Applies a term search order to this course catalog.
Parameters	`osid.course.TermSearchOrder`	`termSearchOrder`	the term search order
Errors	NULL_ARGUMENT		`termSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`termSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getTermQueryFromInspector
Description	Gets a term query from an inspector.
Parameters	`osid.course.TermQueryInspector`	`termQueryInspector`	a query inspector
Return	`osid.course.TermQuery`		the term query
Errors	NULL_ARGUMENT		`termQueryInspector` is `null`
Errors	UNSUPPORTED		`termQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.