OSID - osid.grading.GradeEntryQuerySession Service Interface Definition

Interface	osid.grading.GradeEntryQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.grading.GradeEntrySearchSession`
Used By	`osid.grading.GradingManager`
Used By	`osid.grading.GradingProxyManager`
Description	This session provides methods for searching `GradeEntry` objects. The search query is constructed using the `GradeEntryQuery`. The grade entry record `Type` also specifies the record interface for the grade entry query. This session defines views that offer differing behaviors for searching. federated gradebook view: searches include grade entries in gradebooks of which this gradebook is an ancestor in the gradebook hierarchy isolated gradebook view: searches are restricted to grade entries in this gradebook Grade entries may have a query record indicated by their respective record types. The query record is accessed via the `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	canSearchGradeEntries
Description	Tests if this user can perform `GradeEntry` searches. 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 search 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 grade entries 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	getGradeEntryQuery
Description	Gets a grade entry query.
Return	`osid.grading.GradeEntryQuery`		the grade entry query
Compliance	`mandatory`		This method must be implemented.
Method	getGradeEntriesByQuery
Description	Gets a list of entries matching the given grade entry query.
Parameters	`osid.grading.GradeEntryQuery`	`gradeEntryQuery`	the grade entry query
Return	`osid.grading.GradeEntryList`		the returned `GradeEntryList`
Errors	NULL_ARGUMENT		`gradeEntryQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`gradeEntryQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.