OSID Logo
OSID Specifications
grading package
Version 3.1.0
Interfaceosid.grading.GradebookColumnSearchOrder
Implementsosid.OsidObjectSearchOrder
Used Byosid.grading.GradeEntrySearchOrder
osid.grading.GradebookColumnSearchSession
osid.grading.GradebookColumnSmartGradebookSession
Description

An interface for specifying the ordering of search results.

MethodorderByGradeSystem
Description

Specified a preference for ordering results by the grade system.

Parametersosid.SearchOrderStylestyle search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This 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
Compliancemandatory This method must be implemented.
MethodgetGradebookColumnSummarySearchOrder
Description

Gets the search order for a grade system.

Returnosid.grading.GradeSystemSearchOrder the grade system search order
ErrorsUNIMPLEMENTED supportsGradeSystemSearchOrder() is false
Complianceoptional This 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
Compliancemandatory This method must be implemented.
MethodgetGradeSystemSearchOrder
Description

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

Returnosid.grading.GradebookColumnSummarySearchOrder the gradebook column summary search order
ErrorsUNIMPLEMENTED supportsGradebookColumnSummarySearchOrder() is false
Complianceoptional This 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.TypegradebookColumnRecordType a gradebook column record type
Returnosid.grading.records.GradebookColumnSearchOrderRecord the gradebook column search order record
ErrorsNULL_ARGUMENT gradebookColumnRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(gradebookColumnRecordType) is false
Compliancemandatory This method must be implemented.