OSID Logo
OSID Specifications
grading package
Version 3.0.0
Release Candidate Preview
Interfaceosid.grading.GradeEntrySearchOrder
Implementsosid.OsidRelationshipSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByGradebookColumn
Description

Specified a preference for ordering results by the gradebook column.

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

Tests if a GradebookColumnSearchOrder is available.

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

Gets the search order for a gradebook column.

Returnosid.grading.GradebookColumnSearchOrderthe gradebook column search order
ErrorsUNIMPLEMENTED supportsGradebookColumnSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsGradebookColumnSearchOrder() is true.
MethodorderByKeyResource
Description

Specified a preference for ordering results by the key resource.

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

Tests if a ResourceSearchOrder is available.

Returnboolean true if a key resource search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetKeyResourceSearchOrder
Description

Gets the search order for a resource.

Returnosid.resource.ResourceSearchOrderthe key resource search order
ErrorsUNIMPLEMENTED supportsKeyResourceSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsKeyResourceSearchOrder() is true.
MethodorderByDerived
Description

Specified a preference for ordering results by the derived entries.

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

Specified a preference for ordering results by the ignore for calculations flag.

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

Specified a preference for ordering results by the grade or score.

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

Tests if a GradeSearchOrder is available.

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

Gets the search order for a grade.

Returnosid.grading.GradeSearchOrderthe grade search order
ErrorsUNIMPLEMENTED supportsGradeSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsGradeSearchOrder() is true.
MethodorderByTimeGraded
Description

Specified a preference for ordering results by the time graded.

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

Specified a preference for ordering results by the grader.

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

Tests if a ResourceSearchOrder is available for grader resources.

Returnboolean true if a resource search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetGraderSearchOrder
Description

Gets the search order for a grader.

Returnosid.resource.ResourceSearchOrderthe resource search order
ErrorsUNIMPLEMENTED supportsGraderSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsGraderSearchOrder() is true.
MethodorderByGradingAgent
Description

Specified a preference for ordering results by the grading agent.

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

Tests if an AgentSearchOrder is available fo grading agents.

Returnboolean true if an agent search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetGradingAgentSearchOrder
Description

Gets the search order for a grading agent.

Returnosid.authentication.AgentSearchOrderthe agent search order
ErrorsUNIMPLEMENTED supportsGradingAgentSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsGradingAgentSearchOrder() is true.
MethodgetGradeEntrySearchOrderRecord
Description

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

Parametersosid.type.TypegradeEntryRecordTypea grade entry record type
Returnosid.grading.records.GradeEntrySearchOrderRecordthe grade entry search order record
ErrorsNULL_ARGUMENT gradeEntryRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(gradeEntryRecordType) is false
CompliancemandatoryThis method must be implemented.