OSID Logo
OSID Specifications
learning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.learning.ObjectiveSearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidFederateableSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByAssessment
Description

Specified a preference for ordering results by the assessment.

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

Tests if an AssessmentSearchOrder is available.

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

Gets the search order for an assessment.

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

Specifies a preference for ordering the result set by the knowledge category.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsKnowledgeCategorySearchOrder
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.
MethodgetKnowledgeCategorySearchOrder
Description

Gets a grade search order to order on knolwgedge category.

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

Specifies a preference for ordering the result set by the cognitive process.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsCognitiveProcessSearchOrder
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.
MethodgetCognitiveProcessSearchOrder
Description

Gets a grade search order to order on cognitive process.

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

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

Parametersosid.type.TypeobjectiveRecordTypean objective record type
Returnosid.learning.records.ObjectiveSearchOrderRecordthe objective search order record
ErrorsNULL_ARGUMENT objectiveRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(objectiveRecordType) is false
CompliancemandatoryThis method must be implemented.