OSID Logo
OSID Specifications
grading package
Version 3.0.0
Release Candidate Preview
Interfaceosid.grading.GradeEntrySearchSession
Implementsosid.grading.GradeEntryQuerySession
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 a 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.

MethodgetGradeEntrySearch
Description

Gets a grade entry search.

Returnosid.grading.GradeEntrySearchthe grade entry search
CompliancemandatoryThis method must be implemented.
MethodgetGradeEntrySearchOrder
Description

Gets a grade entry search order. The GradeEntrySearchOrder is supplied to a GradeEntrySearch to specify the ordering of results.

Returnosid.grading.GradeEntrySearchOrderthe grade entry search order
CompliancemandatoryThis method must be implemented.
MethodgetGradeEntriesBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.grading.GradeEntryQuerygradeEntryQuerythe grade entry query
osid.grading.GradeEntrySearchgradeEntrySearchthe grade entry search
Returnosid.grading.GradeEntrySearchResultsthe grade entry search results
ErrorsNULL_ARGUMENT gradeEntryQuery or gradeEntrySearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED gradeEntrySearch or gradeEntryQuery is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetGradeEntryQueryFromInspector
Description

Gets a grade entry query from an inspector. The inspector is available from an GradeEntrySearchResults.

Parametersosid.grading.GradeEntryQueryInspectorgradeEntryQueryInspectora grade entry query inspector
Returnosid.grading.GradeEntryQuerythe grade entry query
ErrorsNULL_ARGUMENT gradeEntryQueryInspector is null
UNSUPPORTED gradeEntryQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.