OSID - osid.grading.GradeQuerySession Service Interface Definition

Interface	osid.grading.GradeQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.grading.GradeSearchSession`
Used By	`osid.grading.GradingManager`
Used By	`osid.grading.GradingProxyManager`
Description	This session provides methods for searching among `Grades` . The search query is constructed using the `GradeQuery` . This session defines views that offer differing behaviors for searching. federated gradebook view: searches include grades in gradebooks of which this gradebook is an ancestor in the gradebook hierarchy isolated gradebook view: searches are restricted to grades in this gradebook Grades may have a query record indicated by their respective record types. The query record is accessed via the `GradebookQuery` .
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	canSearchGrades
Description	Tests if this user can perform `Grade` lookups. 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 not offer lookup operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedGradebookView
Description	Federates the view for methods in this session. A federated view will include grades in gradebooks which are children of this gradebook in the gradebook hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedGradebookView
Description	Isolates the view for methods in this session. An isolated view restricts searches to this gradebook only.
Compliance	`mandatory`		This method is 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	getGradesByQuery
Description	Gets a list of `Grades` matching the given search.
Parameters	`osid.grading.GradeQuery`	`gradeQuery`	the grade query
Return	`osid.grading.GradeList`		the returned `GradeList`
Errors	NULL_ARGUMENT		`gradeQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`gradeQuery` did not originate from `getGradeQuery()`
Compliance	`mandatory`		This method must be implemented.