Interface GradebookColumnSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface GradebookColumnSearch
extends OsidSearch

GradebookColumnSearch defines the interface for specifying grading search options.

Method Summary

Modifier and Type	Method	Description
GradebookColumnSearchRecord	getGradebookColumnSearchRecord(Type gradebookColumnSearchRecordType)	Gets the gradebook column search record corresponding to the given gradebook column search record Type .This method is used to retrieve an object implementing the requested record.
void	orderGradebookColumnResults(GradebookColumnSearchOrder gradebookColumnSearchOrder)	Specify an ordering to the search results.
void	searchAmongGradebookColumns(IdList gradebookColumnIds)	Execute this search among the given list of gradebook columns.

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

searchAmongGradebookColumns

void searchAmongGradebookColumns(IdList gradebookColumnIds)

Execute this search among the given list of gradebook columns.

Parameters:

gradebookColumnIds - list of gradebook columns

Throws:

NullArgumentException - gradebookColumnIds is null

Compliance:

mandatory - This method must be implemented.

orderGradebookColumnResults

void orderGradebookColumnResults(GradebookColumnSearchOrder gradebookColumnSearchOrder)

Specify an ordering to the search results.

Parameters:

gradebookColumnSearchOrder - gradebook column search order

Throws:

NullArgumentException - gradebookColumnSearchOrder is null

UnsupportedException - gradebookColumnSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getGradebookColumnSearchRecord

GradebookColumnSearchRecord getGradebookColumnSearchRecord(Type gradebookColumnSearchRecordType)
                                                    throws OperationFailedException

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

Parameters:

gradebookColumnSearchRecordType - a gradebook column search record type

Returns:

the gradebook column search record

Throws:

NullArgumentException - gradebookColumnSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(gradebookColumnSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.