Interface GradeSystemSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface GradeSystemSearch
extends OsidSearch

The interface for governing grade system searches.

Method Summary

Modifier and Type	Method	Description
GradeSystemSearchRecord	getGradeSystemSearchRecord(Type gradeSystemSearchRecordType)	Gets the grade system search record corresponding to the given grade system search record Type .This method is used to retrieve an object implementing the requested record.
void	orderGradeSystemResults(GradeSystemSearchOrder gradeSystemSearchOrder)	Specify an ordering to the search results.
void	searchAmongGradeSystems(IdList gradeSystemIds)	Execute this search among the given list of grade systems.

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

searchAmongGradeSystems

void searchAmongGradeSystems(IdList gradeSystemIds)

Execute this search among the given list of grade systems.

Parameters:

gradeSystemIds - list of grade systems

Throws:

NullArgumentException - gradeSystemIds is null

Compliance:

mandatory - This method must be implemented.

orderGradeSystemResults

void orderGradeSystemResults(GradeSystemSearchOrder gradeSystemSearchOrder)

Specify an ordering to the search results.

Parameters:

gradeSystemSearchOrder - grade system search order

Throws:

NullArgumentException - gradeSystemSearchOrder is null

UnsupportedException - gradeSystemSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getGradeSystemSearchRecord

GradeSystemSearchRecord getGradeSystemSearchRecord(Type gradeSystemSearchRecordType)
                                            throws OperationFailedException

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

Parameters:

gradeSystemSearchRecordType - a grade system search record type

Returns:

the grade system search record

Throws:

NullArgumentException - gradeSystemSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(gradeSystemSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.