OSID Logo
OSID Specifications
grading package
Version 3.0.0
Release Candidate Preview
Interfaceosid.grading.GradeSystemSearchSession
Implementsosid.grading.GradeSystemQuerySession
Description

This session provides methods for searching among GradeSystems. The search query is constructed using the GradeSystemQuery.

getGradeSystemsByQuery() is the basic search method and returns a list of GradeSystems. A more advanced search may be performed with getGradeSystemsBySearch(). It accepts a GradeSystemSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getGradeSystemsBySearch() returns a GradeSystemSearchResults that can be used to access the resulting GradeSystemList or be used to perform a search within the result set through GradeSystemSearch.

This session defines views that offer differing behaviors for searching.

  • federated gradebook view: searches include grade systems in gradebooks of which this gradebook is a ancestor in the gradebook hierarchy
  • isolated gradebook view: searches are restricted to grade systems in this gradebook

Grade systems may have a query record indicated by their respective record types. The query record is accessed via the GradeSystemQuery.

MethodgetGradeSystemSearch
Description

Gets a grade system search.

Returnosid.grading.GradeSystemSearcha grade system search
CompliancemandatoryThis method must be implemented.
MethodgetGradeSystemSearchOrder
Description

Gets a grade system search order. The GradeSystemSearchOrder is supplied to a GradeSystemSearch to specify the ordering of results.

Returnosid.grading.GradeSystemSearchOrderthe grade system search order
CompliancemandatoryThis method must be implemented.
MethodgetGradeSystemsBySearch
Description

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

Parametersosid.grading.GradeSystemQuerygradeSystemQuerythe grade system query
osid.grading.GradeSystemSearchgradeSystemSearchthe grade system search
Returnosid.grading.GradeSystemSearchResultsthe grade system search results
ErrorsNULL_ARGUMENT gradeSystemQuery or gradeSystemSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED gradeSystemQuery or gradeSystemSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetGradeSystemQueryFromInspector
Description

Gets a grade system query from an inspector. The inspector is available from an GradeSystemSearchResults.

Parametersosid.grading.GradeSystemQueryInspectorgradeSystemQueryInspectora grade system query inspector
Returnosid.grading.GradeSystemQuerythe grade system query
ErrorsNULL_ARGUMENT gradeSystemQueryInspector is null
UNSUPPORTED gradeSystemQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.