OSID Logo
OSID Specifications
offering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.ResultSearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidTemporalSearchOrder
osid.OsidSubjugateableSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByParticipant
Description

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

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

Tests if a participant search order is available.

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

Gets the participant search order.

Returnosid.offering.ParticipantSearchOrderthe participant search order
ErrorsUNIMPLEMENTED supportsParticipantSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsParticipantSearchOrder() is true.
MethodorderByGrade
Description

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

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

Gets the grade search order.

Returnosid.grading.GradeSearchOrderthe grade search order
ErrorsUNIMPLEMENTED supportsGradeSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsGradeSearchOrder() is true.
MethodorderByValue
Description

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

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

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

Parametersosid.type.TyperesultRecordTypean result record type
Returnosid.offering.records.ResultSearchOrderRecordthe result search order record
ErrorsNULL_ARGUMENT resultRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(resultRecordType) is false
CompliancemandatoryThis method must be implemented.