Interface GradebookColumnSearchOrder

All Superinterfaces:

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

public interface GradebookColumnSearchOrder
extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Modifier and Type	Method	Description
GradebookColumnSearchOrderRecord	getGradebookColumnSearchOrderRecord(Type gradebookColumnRecordType)	Gets the gradebook column search order record corresponding to the given gradebook column record Type .Multiple retrievals return the same underlying object.
GradeSystemSearchOrder	getGradebookColumnSummarySearchOrder()	Gets the search order for a grade system.
GradebookColumnSummarySearchOrder	getGradeSystemSearchOrder()	Gets the search order for a gradebook column summary search order.
void	orderByGradeSystem(SearchOrderStyle style)	Specified a preference for ordering results by the grade system.
boolean	supportsGradebookColumnSummarySearchOrder()	Tests if a GradebookColumnSummarySearchOrder is available for gradebook column summaries.
boolean	supportsGradeSystemSearchOrder()	Tests if a GradeSystemSearchOrder is available for grade systems.

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

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 is available for grade systems.

Returns:

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

Compliance:

mandatory - This method must be implemented.

getGradebookColumnSummarySearchOrder

GradeSystemSearchOrder getGradebookColumnSummarySearchOrder()

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 {@code supportsGradeSystemSearchOrder()} is {@code true} .

supportsGradebookColumnSummarySearchOrder

boolean supportsGradebookColumnSummarySearchOrder()

Tests if a GradebookColumnSummarySearchOrder is available for gradebook column summaries.

Returns:

true if a gradebook column summary search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getGradeSystemSearchOrder

GradebookColumnSummarySearchOrder getGradeSystemSearchOrder()

Gets the search order for a gradebook column summary search order.

Returns:

the gradebook column summary search order

Throws:

UnimplementedException - supportsGradebookColumnSummarySearchOrder() is false

Compliance:

optional - This method must be implemented if {@code supportsGradebookColumnSummarySearchOrder()} is {@code true} .

getGradebookColumnSearchOrderRecord

GradebookColumnSearchOrderRecord getGradebookColumnSearchOrderRecord(Type gradebookColumnRecordType)
                                                              throws OperationFailedException

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

Parameters:

gradebookColumnRecordType - a gradebook column record type

Returns:

the gradebook column search order record

Throws:

NullArgumentException - gradebookColumnRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(gradebookColumnRecordType) is false

Compliance:

mandatory - This method must be implemented.