org.osid.grading

Interface GradebookColumnSummarySearchOrder

All Superinterfaces:

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

public interface GradebookColumnSummarySearchOrder
extends OsidRuleSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and 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 org.osid.OsidRuleSearchOrder

getRuleSearchOrder, orderByRule, supportsRuleSearchOrder

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.OsidOperableSearchOrder

orderByActive, orderByDisabled, orderByEnabled, orderByOperational

Method Detail

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.