OSID Logo
OSID Specifications
learning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.learning.ProficiencySearchOrder
Implementsosid.OsidRelationshipSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByResource
Description

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

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

Tests if a resource search order is available.

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

Gets a resource search order.

Returnosid.resource.ResourceSearchOrdera resource search order
ErrorsUNIMPLEMENTED supportsResourceSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsResourceSearchOrder() is true.
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.
MethodorderByCompletion
Description

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

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

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

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

Gets a grade search order.

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

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

Parametersosid.type.TypeproficiencyRecordTypea proficiency record type
Returnosid.learning.records.ProficiencySearchOrderRecordthe proficiency search order record
ErrorsNULL_ARGUMENT proficiencyRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(proficiencyRecordType) is false
CompliancemandatoryThis method must be implemented.