OSID Logo
OSID Specifications
learning package
Version 3.1.0
Interfaceosid.learning.ActivitySearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidSubjugateableSearchOrder
Used Byosid.learning.ActivitySearchSession
osid.learning.ActivitySmartObjectiveBankSession
Description

An interface for specifying the ordering of search results.

MethodorderByObjective
Description

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

Parametersosid.SearchOrderStylestyle search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This method must be implemented.
MethodsupportsObjectiveSearchOrder
Description

Tests if an objective search order is available.

Returnboolean true if an objective search order is available, false otherwise
Compliancemandatory This method must be implemented.
MethodgetObjectiveSearchOrder
Description

Gets an objective search order.

Returnosid.learning.ObjectiveSearchOrder an objective search order
ErrorsUNIMPLEMENTED supportsObjectiveSearchOrder() is false
Complianceoptional This method must be implemented if supportsObjectiveSearchOrder() is true.
MethodgetActivitySearchOrderRecord
Description

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

Parametersosid.type.TypeactivityRecordType an activity record type
Returnosid.learning.records.ActivitySearchOrderRecord the activity search order record
ErrorsNULL_ARGUMENT activityRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(activityRecordType) is false
Compliancemandatory This method must be implemented.