OSID - osid.grading.GradeEntrySmartGradebookSession Service Interface Definition

Interface	osid.grading.GradeEntrySmartGradebookSession
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 `GradeEntryQuery` can be retrieved from this session and mapped to this `Gradebook` to create a virtual collection of `GradeEntries` . The entries may be sequenced using the `GradeEntrySearchOrder` from this session. This `Gradebook` has a default query that matches any grade entry and a default search order that specifies no sequencing. The queries may be examined using a `GradeEntryQueryInspector` . The query may be modified by converting the inspector back to a `GradeEntryQuery` .
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	getGradeEntryQuery
Description	Gets a grade entry query.
Return	`osid.grading.GradeEntryQuery`		the grade entry query
Compliance	`mandatory`		This method must be implemented.
Method	getGradeEntrySearchOrder
Description	Gets a grade entry search order.
Return	`osid.grading.GradeEntrySearchOrder`		the grade entry search order
Compliance	`mandatory`		This method must be implemented.
Method	applyGradeEntryQuery
Description	Applies a grade entry query to this gradebook.
Parameters	`osid.grading.GradeEntryQuery`	`gradeEntryQuery`	the grade entry query
Errors	NULL_ARGUMENT		`gradeEntryQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`gradeEntryQuery` didi not originate from `getGradeEntryQuery()`
Compliance	`mandatory`		This method must be implemented.
Method	inspectGradeEntryQuery
Description	Gets a grade entry query inspector for this gradebook.
Return	`osid.grading.GradeEntryQueryInspector`		the grade entry query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyGradeEntrySequencing
Description	Applies a grade entry search order to this gradebook.
Parameters	`osid.grading.GradeEntrySearchOrder`	`gradeEntrySearchOrder`	the grade entry search order
Errors	NULL_ARGUMENT		`gradeEntrySearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`gradeEntrySearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getGradeEntryQueryFromInspector
Description	Gets a grade entry query from an inspector.
Parameters	`osid.grading.GradeEntryQueryInspector`	`gradeEntryQueryInspector`	a grade entry query inspector
Return	`osid.grading.GradeEntryQuery`		the grade entry query
Errors	NULL_ARGUMENT		`gradeEntryQueryInspector` is `null`
Errors	UNSUPPORTED		`gradeEntryQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.