OSID Logo
OSID Specifications
grading package
Version 3.0.0
Release Candidate Preview
Interfaceosid.grading.GradebookSearch
Implementsosid.OsidSearch
Description

The interface for governing gradebook searches.

MethodsearchAmongGradebooks
Description

Execute this search among the given list of gradebooks.

Parametersosid.id.IdListgradebookIdslist of gradebooks
ErrorsNULL_ARGUMENT gradebookIds is null
CompliancemandatoryThis method must be implemented.
MethodorderGradebookResults
Description

Specify an ordering to the search results.

Parametersosid.grading.GradebookSearchOrdergradebookSearchOrdergradebook search order
ErrorsNULL_ARGUMENT gradebookSearchOrder is null
UNSUPPORTED gradebookSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetGradebookSearchRecord
Description

Gets the gradebook search 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.GradebookSearchRecordthe gradebook search record
ErrorsNULL_ARGUMENT gradebookSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(gradebookSearchRecordType) is false
CompliancemandatoryThis method must be implemented.