org.osid.offering

Interface ResultSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, OsidSubjugateableSearchOrder, OsidTemporalSearchOrder, Suppliable

public interface ResultSearchOrder
extends OsidObjectSearchOrder, OsidTemporalSearchOrder, OsidSubjugateableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
GradeSearchOrder	getGradeSearchOrder() Gets the grade search order.
ParticipantSearchOrder	getParticipantSearchOrder() Gets the participant search order.
ResultSearchOrderRecord	getResultSearchOrderRecord(Type resultRecordType) Gets the result search order record corresponding to the given result record Type.
void	orderByGrade(SearchOrderStyle style) Specifies a preference for ordering the result set by the commitment.
void	orderByParticipant(SearchOrderStyle style) Specifies a preference for ordering the result set by the participant.
void	orderByValue(SearchOrderStyle style) Specifies a preference for ordering the result set by the value.
boolean	supportsGradeSearchOrder() Tests if a grade search order is available.
boolean	supportsParticipantSearchOrder() Tests if a participant search order is available.

Methods inherited from interface org.osid.OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Methods inherited from interface org.osid.OsidIdentifiableSearchOrder

orderById

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidTemporalSearchOrder

orderByEffective, orderByEndDate, orderByStartDate

Method Detail

orderByParticipant

void orderByParticipant(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsParticipantSearchOrder

boolean supportsParticipantSearchOrder()

Tests if a participant search order is available.

Returns:

true if a participant search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getParticipantSearchOrder

ParticipantSearchOrder getParticipantSearchOrder()

Gets the participant search order.

Returns:

the participant search order

Throws:

UnimplementedException - supportsParticipantSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsParticipantSearchOrder() is true.

orderByGrade

void orderByGrade(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsGradeSearchOrder

boolean supportsGradeSearchOrder()

Tests if a grade search order is available.

Returns:

true if a grade search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getGradeSearchOrder

GradeSearchOrder getGradeSearchOrder()

Gets the grade search order.

Returns:

the grade search order

Throws:

UnimplementedException - supportsGradeSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsGradeSearchOrder() is true.

orderByValue

void orderByValue(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getResultSearchOrderRecord

ResultSearchOrderRecord getResultSearchOrderRecord(Type resultRecordType)
                                                   throws OperationFailedException

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

Parameters:

resultRecordType - an result record type

Returns:

the result search order record

Throws:

NullArgumentException - resultRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(resultRecordType) is false

Compliance:

mandatory - This method must be implemented.