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

An interface for specifying the ordering of search results.

MethodorderByObjective
Description

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

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

Gets an objective search order.

Returnosid.learning.ObjectiveSearchOrderan objective search order
ErrorsUNIMPLEMENTED supportsObjectiveSearchOrder() is false
ComplianceoptionalThis 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.TypeactivityRecordTypean activity record type
Returnosid.learning.records.ActivitySearchOrderRecordthe activity search order record
ErrorsNULL_ARGUMENT activityRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(activityRecordType) is false
CompliancemandatoryThis method must be implemented.