OSID - osid.course.requisite.RequisiteSmartCourseCatalogSession Service Interface Definition

Interface	osid.course.requisite.RequisiteSmartCourseCatalogSession
Implements	`osid.OsidSession`
Used By	`osid.course.requisite.CourseRequisiteManager`
Used By	`osid.course.requisite.CourseRequisiteProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `RequisiteQuery` can be retrieved from this session and mapped to this `CourseCatalog` to create a virtual collection of `Requisites`. The courses may be sequenced using the `RequisiteSearchOrder` from this session. This `CourseCatalog` has a default query that matches any course and a default search order that specifies no sequencing. The queries may be examined using a `RequisiteQueryInspector`. The query may be modified by converting the inspector back to a `RequisiteQuery`.
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	getRequisiteQuery
Description	Gets a requisite query.
Return	`osid.course.requisite.RequisiteQuery`		the requisite query
Compliance	`mandatory`		This method must be implemented.
Method	getRequisiteSearchOrder
Description	Gets a requisite search order.
Return	`osid.course.requisite.RequisiteSearchOrder`		the requisite search order
Compliance	`mandatory`		This method must be implemented.
Method	applyRequisiteQuery
Description	Applies a requisite query to this course catalog.
Parameters	`osid.course.requisite.RequisiteQuery`	`requisiteQuery`	the requisite query
Errors	NULL_ARGUMENT		`requisiteQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`requisiteQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectRequisiteQuery
Description	Gets a requisite query inspector for this course catalog.
Return	`osid.course.requisite.RequisiteQueryInspector`		the requisite query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyRequisiteSequencing
Description	Applies a requisite search order to this course catalog.
Parameters	`osid.course.requisite.RequisiteSearchOrder`	`requisiteSearchOrder`	the requisite search order
Errors	NULL_ARGUMENT		`requisiteSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`requisiteSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getRequisiteQueryFromInspector
Description	Gets a requisite query from an inspector.
Parameters	`osid.course.requisite.RequisiteQueryInspector`	`requisiteQueryInspector`	a query inspector
Return	`osid.course.requisite.RequisiteQuery`		the requisite query
Errors	NULL_ARGUMENT		`requisiteQueryInspector` is `null`
Errors	UNSUPPORTED		`requisiteQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.