OSID Logo
OSID Specifications
assessment package
Version 3.1.0
Interfaceosid.assessment.ItemSearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidAggregateableSearchOrder
Used Byosid.assessment.ItemSearchSession
osid.assessment.ItemSmartBankSession
Description

An interface for specifying the ordering of search results.

MethodorderByQuestion
Description

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

Parametersosid.SearchOrderStylestyle search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This 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
Compliancemandatory This method must be implemented.
MethodgetQuestionSearchOrder
Description

Gets a question search order.

Returnosid.assessment.QuestionSearchOrder a question search order
ErrorsUNIMPLEMENTED supportsQuestionSearchOrder() is false
Complianceoptional This 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.TypeitemRecordType an item record type
Returnosid.assessment.records.ItemSearchOrderRecord the item search order record
ErrorsNULL_ARGUMENT itemRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(itemRecordType) is false
Compliancemandatory This method must be implemented.