org.osid.grading

Interface GradeSearchOrder

All Superinterfaces:

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

public interface GradeSearchOrder
extends OsidObjectSearchOrder, OsidSubjugateableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
GradeSearchOrderRecord	getGradeSearchOrderRecord(Type gradeRecordType) Gets the grade search order record corresponding to the given grade record Type.
GradeSystemSearchOrder	getGradeSystemSearchOrder() Gets the search order for a grade system.
void	orderByGradeSystem(SearchOrderStyle style) Specified a preference for ordering results by the grade system.
void	orderByInputScoreEndRange(SearchOrderStyle style) Specified a preference for ordering results by end of the input score range.
void	orderByInputScoreStartRange(SearchOrderStyle style) Specified a preference for ordering results by start of the input score range.
void	orderByOutputScore(SearchOrderStyle style) Specified a preference for ordering results by the output score.
boolean	supportsGradeSystemSearchOrder() Tests if a GradeSystemSearchOrder interface is available for grade systems.

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

Method Detail

orderByGradeSystem

void orderByGradeSystem(SearchOrderStyle style)

Specified a preference for ordering results by the grade system.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsGradeSystemSearchOrder

boolean supportsGradeSystemSearchOrder()

Tests if a GradeSystemSearchOrder interface is available for grade systems.

Returns:

true if a grade system search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getGradeSystemSearchOrder

GradeSystemSearchOrder getGradeSystemSearchOrder()

Gets the search order for a grade system.

Returns:

the grade system search order

Throws:

UnimplementedException - supportsGradeSystemSearchOrder() is false

Compliance:

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

orderByInputScoreStartRange

void orderByInputScoreStartRange(SearchOrderStyle style)

Specified a preference for ordering results by start of the input score range.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByInputScoreEndRange

void orderByInputScoreEndRange(SearchOrderStyle style)

Specified a preference for ordering results by end of the input score range.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByOutputScore

void orderByOutputScore(SearchOrderStyle style)

Specified a preference for ordering results by the output score.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getGradeSearchOrderRecord

GradeSearchOrderRecord getGradeSearchOrderRecord(Type gradeRecordType)
                                                 throws OperationFailedException

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

Parameters:

gradeRecordType - a grade record type

Returns:

the grade search order record

Throws:

NullArgumentException - gradeRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(gradeRecordType) is false

Compliance:

mandatory - This method must be implemented.