Interface GradeEntrySearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface GradeEntrySearch
extends OsidSearch

GradeEntrySearch defines the interface for specifying package search options.

Method Summary

Modifier and Type	Method	Description
GradeEntrySearchRecord	getGradeEntrySearchRecord(Type gradeEntrySearchRecordType)	Gets the grade entry search record corresponding to the given package search record Type .
void	orderGradeEntryResults(GradeEntrySearchOrder gradeEntrySearchOrder)	Specify an ordering to the search results.
void	searchAmongGradeEntries(IdList gradeEntryIds)	Execute this search among the given list of grade entries.

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

searchAmongGradeEntries

void searchAmongGradeEntries(IdList gradeEntryIds)

Execute this search among the given list of grade entries.

Parameters:

gradeEntryIds - list of grade entries

Throws:

NullArgumentException - gradeEntryIds is null

Compliance:

mandatory - This method must be implemented.

orderGradeEntryResults

void orderGradeEntryResults(GradeEntrySearchOrder gradeEntrySearchOrder)

Specify an ordering to the search results.

Parameters:

gradeEntrySearchOrder - package search order

Throws:

NullArgumentException - gradeEntrySearchOrder is null

UnsupportedException - gradeEntrySearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getGradeEntrySearchRecord

GradeEntrySearchRecord getGradeEntrySearchRecord(Type gradeEntrySearchRecordType)
                                          throws OperationFailedException

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

Parameters:

gradeEntrySearchRecordType - a grade entry search record type

Returns:

the grade entry search record

Throws:

NullArgumentException - gradeEntrySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(gradeEntrySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.