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

GradebookColumnSearch defines the interface for specifying grading search options.

MethodsearchAmongGradebookColumns
Description

Execute this search among the given list of gradebook columns.

Parametersosid.id.IdListgradebookColumnIdslist of gradebook columns
ErrorsNULL_ARGUMENT gradebookColumnIds is null
CompliancemandatoryThis method must be implemented.
MethodorderGradebookColumnResults
Description

Specify an ordering to the search results.

Parametersosid.grading.GradebookColumnSearchOrdergradebookColumnSearchOrdergradebook column search order
ErrorsNULL_ARGUMENT gradebookColumnSearchOrder is null
UNSUPPORTED gradebookColumnSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetGradebookColumnSearchRecord
Description

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

Parametersosid.type.TypegradebookColumnSearchRecordTypea gradebook column search record type
Returnosid.grading.records.GradebookColumnSearchRecordthe gradebook column search record
ErrorsNULL_ARGUMENT gradebookColumnSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(gradebookColumnSearchRecordType) is false
CompliancemandatoryThis method must be implemented.