OSID - osid.grading.GradeSmartGradebookSession Service Interface Definition

Interface	osid.grading.GradeSmartGradebookSession
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 `GradeQuery` can be retrieved from this session and mapped to this `Gradebook` to create a virtual collection of `Grades` . The grades may be sequenced using the `GradeSearchOrder` from this session. This `Gradebook` has a default query that matches any grade and a default search order that specifies no sequencing. The queries may be examined using a `GradeQueryInspector` . The query may be modified by converting the inspector back to a `GradeQuery` .
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
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 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 gradebook management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getGradeQuery
Description	Gets a grade query.
Return	`osid.grading.GradeQuery`		the grade query
Compliance	`mandatory`		This method must be implemented.
Method	getGradeSearchOrder
Description	Gets a grade search order.
Return	`osid.grading.GradeSearchOrder`		the grade search order
Compliance	`mandatory`		This method must be implemented.
Method	applyGradeQuery
Description	Applies a grade query to this gradebook.
Parameters	`osid.grading.GradeQuery`	`gradeQuery`	the grade query
Errors	NULL_ARGUMENT		`gradeQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`gradeQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectGradeQuery
Description	Gets a grade query inspector for this gradebook.
Return	`osid.grading.GradeQueryInspector`		the grade query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyGradeSequencing
Description	Applies a grade search order to this gradebook.
Parameters	`osid.grading.GradeSearchOrder`	`gradeSearchOrder`	the grade search order
Errors	NULL_ARGUMENT		`gradeSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`gradeSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getGradeQueryFromInspector
Description	Gets a grade query from an inspector.
Parameters	`osid.grading.GradeQueryInspector`	`gradeQueryInspector`	a grade query inspector
Return	`osid.grading.GradeQuery`		the grade query
Errors	NULL_ARGUMENT		`gradeQueryInspector` is `null`
Errors	UNSUPPORTED		`gradeQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.