OSID Logo
OSID Specifications
assessment package
Version 3.0.0
Release Candidate Preview
Interfaceosid.assessment.AssessmentOfferedSearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidSubjugateableSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByAssessment
Description

Specifies a preference for ordering the result set by the assessment.

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

Tests if an assessment search order is available.

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

Gets an assessment search order.

Returnosid.assessment.AssessmentSearchOrderan assessment search order
ErrorsUNIMPLEMENTED supportsAssessmentSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsAssessmentSearchOrder() is true.
MethodorderByLevel
Description

Specifies a preference for ordering the result set by the level of difficulty.

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

Tests if a grade search order is available.

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

Gets a grade search order.

Returnosid.grading.GradeSearchOrdera grade search order
ErrorsUNIMPLEMENTED supportsLevelSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsLevelSearchOrder() is true.
MethodorderByItemsSequential
Description

Specifies a preference for ordering the result set by the sequential flag.

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

Specifies a preference for ordering the result set by the shuffle flag.

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

Specifies a preference for ordering the result set by the assessment start time.

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

Specifies a preference for ordering the result set by the assessment deadline.

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

Specifies a preference for ordering the result set by the duration.

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

Specifies a preference for ordering the result set by the grade system for scores.

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

Tests if a grade system search order is available.

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

Gets a grade system search order.

Returnosid.grading.GradeSystemSearchOrdera grade system search order
ErrorsUNIMPLEMENTED supportsScoreSystemSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsScoreSystemSearchOrder() is true.
MethodorderByGradeSystem
Description

Specifies a preference for ordering the result set by the grade system for grades.

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

Tests if a grade system search order is available.

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

Gets a grade system search order.

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

Specifies a preference for ordering the result set by the rubric assessment offered.

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

Tests if an assessment offered search order is available.

Returnboolean true if an assessment offered search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRubricSearchOrder
Description

Gets an assessment offered search order.

Returnosid.assessment.AssessmentOfferedSearchOrdera rubric assessment offered search order
ErrorsUNIMPLEMENTED supportsRubricSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsRubricSearchOrder() is true.
MethodgetAssessmentOfferedSearchOrderRecord
Description

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

Parametersosid.type.TypeassessmentOfferedRecordTypean assessment offered record type
Returnosid.assessment.records.AssessmentOfferedSearchOrderRecordthe assessment offered search order record
ErrorsNULL_ARGUMENT assessmentOfferedRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(assessmentOfferedRecordType) is false
CompliancemandatoryThis method must be implemented.