OSID - osid.grading.GradeEntrySearchSession Service Interface Definition

Interface	osid.grading.GradeEntrySearchSession
Implements	`osid.grading.GradeEntryQuerySession`
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`. `getGradeEntriesByQuery()` is the basic search method and returns a list of `GradeEntry` objects.A more advanced search may be performed with `getGradeEntriesBySearch()`. It accepts a `GradeEntrySearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getGradeEntriesBySearch()` returns a `GradeEntrySearchResults` that can be used to access the resulting `GradeEntryList` or be used to perform a search within the result set through `GradeEntrySearch`. 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	getGradeEntrySearch
Description	Gets a grade entry search.
Return	`osid.grading.GradeEntrySearch`		the grade entry search
Compliance	`mandatory`		This method must be implemented.
Method	getGradeEntrySearchOrder
Description	Gets a grade entry search order. The `GradeEntrySearchOrder` is supplied to a `GradeEntrySearch` to specify the ordering of results.
Return	`osid.grading.GradeEntrySearchOrder`		the grade entry search order
Compliance	`mandatory`		This method must be implemented.
Method	getGradeEntriesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.grading.GradeEntryQuery`	`gradeEntryQuery`	the grade entry query
Parameters	`osid.grading.GradeEntrySearch`	`gradeEntrySearch`	the grade entry search
Return	`osid.grading.GradeEntrySearchResults`		the grade entry search results
Errors	NULL_ARGUMENT		`gradeEntryQuery` or `gradeEntrySearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`gradeEntrySearch` or `gradeEntryQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getGradeEntryQueryFromInspector
Description	Gets a grade entry query from an inspector. The inspector is available from an `GradeEntrySearchResults`.
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.