org.osid.grading

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

Methods

Modifier and Type	Method and Description
GradebookColumnSearchOrderRecord	getGradebookColumnSearchOrderRecord(Type gradebookColumnRecordType) Gets the gradebook column search order record corresponding to the given gradebook column record Type.
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 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 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 supportsGradeSystemSearchOrder() is 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 supportsGradebookColumnSummarySearchOrder() is 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.