org.osid.grading

Interface GradebookSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidCatalogSearchOrder, OsidExtensibleSearchOrder, OsidFederateableSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, OsidSourceableSearchOrder, Suppliable

public interface GradebookSearchOrder
extends OsidCatalogSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
GradebookSearchOrderRecord	getGradebookSearchOrderRecord(Type gradebookRecordType) Gets the gradebook search order record corresponding to the given gradebook record Type.

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

getProviderSearchOrder, orderByProvider, supportsProviderSearchOrder

Method Detail

getGradebookSearchOrderRecord

GradebookSearchOrderRecord getGradebookSearchOrderRecord(Type gradebookRecordType)
                                                         throws OperationFailedException

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

Parameters:

gradebookRecordType - a gradebook record type

Returns:

the gradebook search order record

Throws:

NullArgumentException - gradebookRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(gradebookRecordType) is false

Compliance:

mandatory - This method must be implemented.