Interface GradeSystemSearchOrder

All Superinterfaces:

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

public interface GradeSystemSearchOrder
extends OsidObjectSearchOrder, OsidAggregateableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Modifier and Type	Method	Description
GradeSystemSearchOrderRecord	getGradeSystemSearchOrderRecord(Type gradeSystemRecordType)	Gets the grade system search order record corresponding to the given grade entry record Type .Multiple retrievals return the same underlying object.
void	orderByBasedOnGrades(SearchOrderStyle style)	Orders the results by systems based on grades.
void	orderByHighestNumericScore(SearchOrderStyle style)	Orders the results by highest score.
void	orderByLowestNumericScore(SearchOrderStyle style)	Orders the results by lowest score.
void	orderByNumericScoreIncrement(SearchOrderStyle style)	Orders the results by score increment.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidIdentifiableSearchOrder

orderById

Modifier and Type	Method	Description
void	orderById(SearchOrderStyle style)	Specifies a preference for ordering the result set by the Id .

Methods inherited from interface OsidObjectSearchOrder

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

Modifier and Type	Method	Description
void	orderByCreateTime(SearchOrderStyle style)	Orders by the timestamp of the first journal entry.
void	orderByCumulativeRating(Id bookId, SearchOrderStyle style)	Orders by the cumulative rating in a given Book .
void	orderByDescription(SearchOrderStyle style)	Specifies a preference for ordering the result set by the description.
void	orderByDisplayName(SearchOrderStyle style)	Specifies a preference for ordering the result set by the display name.
void	orderByGenusType(SearchOrderStyle style)	Specifies a preference for ordering the result set by the genus type.
void	orderByLastModifiedTime(SearchOrderStyle style)	Orders by the timestamp of the last journal entry.
void	orderByState(Id processId, SearchOrderStyle style)	Orders by the state in a given Process .
void	orderByStatistic(Id meterId, SearchOrderStyle style)	Orders by a statistic for a given Meter .

Method Details

orderByBasedOnGrades

void orderByBasedOnGrades(SearchOrderStyle style)

Orders the results by systems based on grades.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByLowestNumericScore

void orderByLowestNumericScore(SearchOrderStyle style)

Orders the results by lowest score.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByNumericScoreIncrement

void orderByNumericScoreIncrement(SearchOrderStyle style)

Orders the results by score increment.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByHighestNumericScore

void orderByHighestNumericScore(SearchOrderStyle style)

Orders the results by highest score.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getGradeSystemSearchOrderRecord

GradeSystemSearchOrderRecord getGradeSystemSearchOrderRecord(Type gradeSystemRecordType)
                                                      throws OperationFailedException

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

Parameters:

gradeSystemRecordType - a grade system record type

Returns:

the grade system search order record

Throws:

NullArgumentException - gradeSystemRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(gradeSystemRecordType) is false

Compliance:

mandatory - This method must be implemented.