Interface GradebookColumnSummarySearchOrder

All Superinterfaces:

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

public interface GradebookColumnSummarySearchOrder
extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Modifier and Type	Method	Description
GradebookColumnSummarySearchOrderRecord	getGradebookColumnSummarySearchOrderRecord(Type gradebookColumnSummaryRecordType)	Gets the gradebook column summary search order record corresponding to the given gradebook column summary record Type.
void	orderByMean(SearchOrderStyle style)	Specified a preference for ordering results by the mean.
void	orderByMedian(SearchOrderStyle style)	Specified a preference for ordering results by the median.
void	orderByMode(SearchOrderStyle style)	Specified a preference for ordering results by the mode.
void	orderByRMS(SearchOrderStyle style)	Specified a preference for ordering results by the root mean square.
void	orderByStandardDeviation(SearchOrderStyle style)	Specified a preference for ordering results by the standard deviation.
void	orderBySum(SearchOrderStyle style)	Specified a preference for ordering results by the sum.

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

orderByMean

void orderByMean(SearchOrderStyle style)

Specified a preference for ordering results by the mean.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByMedian

void orderByMedian(SearchOrderStyle style)

Specified a preference for ordering results by the median.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByMode

void orderByMode(SearchOrderStyle style)

Specified a preference for ordering results by the mode.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByRMS

void orderByRMS(SearchOrderStyle style)

Specified a preference for ordering results by the root mean square.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByStandardDeviation

void orderByStandardDeviation(SearchOrderStyle style)

Specified a preference for ordering results by the standard deviation.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderBySum

void orderBySum(SearchOrderStyle style)

Specified a preference for ordering results by the sum.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getGradebookColumnSummarySearchOrderRecord

GradebookColumnSummarySearchOrderRecord getGradebookColumnSummarySearchOrderRecord(Type gradebookColumnSummaryRecordType)
                                                                            throws OperationFailedException

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

Parameters:

gradebookColumnSummaryRecordType - a gradebook column summary record type

Returns:

the gradebook column summary search order record

Throws:

NullArgumentException - gradebookColumnSummaryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(gradebookColumnSummaryRecordType) is false

Compliance:

mandatory - This method must be implemented.