OSID Logo
OSID Specifications
grading package
Version 3.0.0
Release Candidate Preview
Interfaceosid.grading.GradebookColumnSearchOrder
Implementsosid.OsidObjectSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByGradeSystem
Description

Specified a preference for ordering results by the grade system.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsGradeSystemSearchOrder
Description

Tests if a GradeSystemSearchOrder is available for grade systems.

Returnboolean true if a grade system search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetGradebookColumnSummarySearchOrder
Description

Gets the search order for a grade system.

Returnosid.grading.GradeSystemSearchOrderthe grade system search order
ErrorsUNIMPLEMENTED supportsGradeSystemSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsGradeSystemSearchOrder() is true.
MethodsupportsGradebookColumnSummarySearchOrder
Description

Tests if a GradebookColumnSummarySearchOrder is available for gradebook column summaries.

Returnboolean true if a gradebook column summary search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetGradeSystemSearchOrder
Description

Gets the search order for a gradebook column summary search order.

Returnosid.grading.GradebookColumnSummarySearchOrderthe gradebook column summary search order
ErrorsUNIMPLEMENTED supportsGradebookColumnSummarySearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsGradebookColumnSummarySearchOrder() is true.
MethodgetGradebookColumnSearchOrderRecord
Description

Gets the gradebook column search order record corresponding to the given gradebook column record Type. Multiple retrievals return the same underlying object.

Parametersosid.type.TypegradebookColumnRecordTypea gradebook column record type
Returnosid.grading.records.GradebookColumnSearchOrderRecordthe gradebook column search order record
ErrorsNULL_ARGUMENT gradebookColumnRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(gradebookColumnRecordType) is false
CompliancemandatoryThis method must be implemented.