Interface GradebookSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface GradebookSearch
extends OsidSearch

The interface for governing gradebook searches.

Method Summary

Modifier and Type	Method	Description
GradebookSearchRecord	getGradebookSearchRecord(Type gradebookSearchRecordType)	Gets the gradebook search record corresponding to the given gradebook search record Type.
void	orderGradebookResults(GradebookSearchOrder gradebookSearchOrder)	Specify an ordering to the search results.
void	searchAmongGradebooks(IdList gradebookIds)	Execute this search among the given list of gradebooks.

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 OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongGradebooks

void searchAmongGradebooks(IdList gradebookIds)

Execute this search among the given list of gradebooks.

Parameters:

gradebookIds - list of gradebooks

Throws:

NullArgumentException - gradebookIds is null

Compliance:

mandatory - This method must be implemented.

orderGradebookResults

void orderGradebookResults(GradebookSearchOrder gradebookSearchOrder)

Specify an ordering to the search results.

Parameters:

gradebookSearchOrder - gradebook search order

Throws:

NullArgumentException - gradebookSearchOrder is null

UnsupportedException - gradebookSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getGradebookSearchRecord

GradebookSearchRecord getGradebookSearchRecord(Type gradebookSearchRecordType)
                                        throws OperationFailedException

Gets the gradebook search record corresponding to the given gradebook search record Type. This method is used to retrieve an object implementing the requested record.

Parameters:

gradebookSearchRecordType - a gradebook search record type

Returns:

the gradebook search record

Throws:

NullArgumentException - gradebookSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(gradebookSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.