OSID Logo
OSID Specifications
grading package
Version 3.0.0
Release Candidate Preview
Interfaceosid.grading.GradebookSearchResults
Implementsosid.OsidSearchResults
Description

This interface provides a means to capture results of a search.

MethodgetGradebooks
Description

Gets the gradebook list resulting from the search.

Returnosid.grading.GradebookListthe gradebook list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetGradebookQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.grading.GradebookQueryInspectorthe gradebook query inspector
CompliancemandatoryThis method must be implemented.
MethodgetGradebookSearchResultsRecord
Description

Gets the gradebook search results record corresponding to the given gradebook search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypegradebookSearchRecordTypea gradebook search record type
Returnosid.grading.records.GradebookSearchResultsRecordthe gradebook search results record
ErrorsNULL_ARGUMENT gradebookSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(gradebookSearchRecordType) is false
CompliancemandatoryThis method must be implemented.