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

An interface for specifying the ordering of search results.

MethodorderByQuestion
Description

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

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

Tests if a question search order is available.

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

Gets a question search order.

Returnosid.assessment.QuestionSearchOrdera question search order
ErrorsUNIMPLEMENTED supportsQuestionSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsQuestionSearchOrder() is true.
MethodgetItemSearchOrderRecord
Description

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

Parametersosid.type.TypeitemRecordTypean item record type
Returnosid.assessment.records.ItemSearchOrderRecordthe item search order record
ErrorsNULL_ARGUMENT itemRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(itemRecordType) is false
CompliancemandatoryThis method must be implemented.