OSID Logo
OSID Specifications
assessment authoring package
Version 3.0.0
Release Candidate Preview
Interfaceosid.assessment.authoring.SequenceRuleSearchOrder
Implementsosid.OsidRuleSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByAssessmentPart
Description

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

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

Tests if an assessment part search order is available.

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

Gets the assessment order.

Returnosid.assessment.authoring.AssessmentPartSearchOrderthe assessment part search order
ErrorsUNIMPLEMENTED supportsAssessmentPartSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsAssessmentPartSearchOrder() is true.
MethodorderByNextAssessmentPart
Description

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

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

Tests if an assessment part search order is available.

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

Gets the assessment order.

Returnosid.assessment.authoring.AssessmentPartSearchOrderthe assessment part search order
ErrorsUNIMPLEMENTED supportsNextAssessmentPartSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsNextAssessmentPartSearchOrder() is true.
MethodorderByMinimumScore
Description

Specifies a preference for ordering the result set by the minimum score.

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

Specifies a preference for ordering the result set by the maximum score.

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

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

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

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

Parametersosid.type.TypesequenceRuleRecordTypea sequence rule record type
Returnosid.assessment.authoring.records.SequenceRuleSearchOrderRecordthe sequence rule search order record
ErrorsNULL_ARGUMENT sequenceRuleRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(sequenceRuleRecordType) is false
CompliancemandatoryThis method must be implemented.