Interface GradeSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface GradeSearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Modifier and Type	Method	Description
GradeQueryInspector	getGradeQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
GradeList	getGrades()	Gets the grade list resulting from a search.
GradeSearchResultsRecord	getGradeSearchResultsRecord(Type gradeSearchRecordType)	Gets the grade search results record corresponding to the given grade search record Type .This method is used to retrieve an object implementing the requested record.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

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 OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getGrades

GradeList getGrades()

Gets the grade list resulting from a search.

Returns:

the grade list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getGradeQueryInspector

GradeQueryInspector getGradeQueryInspector()

Gets the inspector for the query to examine the terms used in the search.

Returns:

the grade query inspector

Compliance:

mandatory - This method must be implemented.

getGradeSearchResultsRecord

GradeSearchResultsRecord getGradeSearchResultsRecord(Type gradeSearchRecordType)
                                              throws OperationFailedException

Gets the grade search results 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 results record

Throws:

NullArgumentException - gradeSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(gradeSearchRecordTypee) is false

Compliance:

mandatory - This method must be implemented.