Interface GradeSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface GradeSearch
extends OsidSearch

The search interface for governing grade searches.

Method Summary

Modifier and Type	Method	Description
GradeSearchRecord	getGradeSearchRecord(Type gradeSearchRecordType)	Gets the grade search record corresponding to the given grade search record Type.
void	orderGradeResults(GradeSearchOrder gradeSearchOrder)	Specify an ordering to the search results.
void	searchAmongGrades(IdList gradeIds)	Execute this search among the given list of grades.

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

searchAmongGrades

void searchAmongGrades(IdList gradeIds)

Execute this search among the given list of grades.

Parameters:

gradeIds - list of grades

Throws:

NullArgumentException - gradeIds is null

Compliance:

mandatory - This method must be implemented.

orderGradeResults

void orderGradeResults(GradeSearchOrder gradeSearchOrder)

Specify an ordering to the search results.

Parameters:

gradeSearchOrder - grade search order

Throws:

NullArgumentException - gradeSearchOrder is null

UnsupportedException - gradeSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getGradeSearchRecord

GradeSearchRecord getGradeSearchRecord(Type gradeSearchRecordType)
                                throws OperationFailedException

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

Parameters:

gradeSearchRecordType - a grade search record type

Returns:

the grade search record

Throws:

NullArgumentException - gradeSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(gradeSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.