OSID - osid.grading.GradeSystemSmartGradebookSession Service Interface Definition

Interface	osid.grading.GradeSystemSmartGradebookSession
Implements	`osid.OsidSession`
Used By	`osid.grading.GradingManager`
Used By	`osid.grading.GradingProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `GradeSystemQuery` can be retrieved from this session and mapped to this `Gradebook` to create a virtual collection of `GradeSystems`. The entries may be sequenced using the `GradeSystemSearchOrder` from this session. This `Gradebook` has a default query that matches any grade system and a default search order that specifies no sequencing. The queries may be examined using a `GradeSystemQueryInspector`. The query may be modified by converting the inspector back to a `GradeSystemQuery`.
Method	getGradebookId
Description	Gets the `Gradebook` `Id` associated with this session.
Return	`osid.id.Id`		the `Gradebook Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getGradebook
Description	Gets the `Gradebook` associated with this session.
Return	`osid.grading.Gradebook`		the `Gradebook` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSmartGradebooks
Description	Tests if this user can manage smart gradebooks. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 smart operations.
Return	`boolean`		`false` if smart gradebook methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getGradeSystemQuery
Description	Gets a grade system query.
Return	`osid.grading.GradeSystemQuery`		the grade system query
Compliance	`mandatory`		This method must be implemented.
Method	getGradeSystemSearchOrder
Description	Gets a grade system search order.
Return	`osid.grading.GradeSystemSearchOrder`		the grade system search order
Compliance	`mandatory`		This method must be implemented.
Method	applyGradeSystemQuery
Description	Applies a grade system query to this gradebook.
Parameters	`osid.grading.GradeSystemQuery`	`gradeSystemQuery`	the grade system query
Errors	NULL_ARGUMENT		`gradeSystemQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`gradeSystemQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectGradeSystemQuery
Description	Gets a grade system query inspector for this gradebook.
Return	`osid.grading.GradeSystemQueryInspector`		the grade system query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyGradeSystemSequencing
Description	Applies a grade system search order to this gradebook.
Parameters	`osid.grading.GradeSystemSearchOrder`	`gradeSystemSearchOrder`	the grade system search order
Errors	NULL_ARGUMENT		`gradeSystemSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`gradeSystemSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getGradeSystemQueryFromInspector
Description	Gets a grade system query from an inspector.
Parameters	`osid.grading.GradeSystemQueryInspector`	`gradeSystemQueryInspector`	a grade system query inspector
Return	`osid.grading.GradeSystemQuery`		the grade system query
Errors	NULL_ARGUMENT		`gradeSystemQueryInspector` is `null`
Errors	UNSUPPORTED		`gradeSystemQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.