OSID Logo
OSID Specifications
grading package
Version 3.0.0
Release Candidate Preview
Interfaceosid.grading.GradeSearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidSubjugateableSearchOrder
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 interface is available for grade systems.

Returnboolean true if a grade system search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetGradeSystemSearchOrder
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.
MethodorderByInputScoreStartRange
Description

Specified a preference for ordering results by start of the input score range.

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

Specified a preference for ordering results by end of the input score range.

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

Specified a preference for ordering results by the output score.

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

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

Parametersosid.type.TypegradeRecordTypea grade record type
Returnosid.grading.records.GradeSearchOrderRecordthe grade search order record
ErrorsNULL_ARGUMENT gradeRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(gradeRecordType) is false
CompliancemandatoryThis method must be implemented.