Interface GradeSystemSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface GradeSystemSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
GradeSystemQueryInspector	getGradeSystemQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
GradeSystemList	getGradeSystems()	Gets the grade system list resulting from the search.
GradeSystemSearchResultsRecord	getGradeSystemSearchResultsRecord(Type gradeSystemSearchRecordType)	Gets the grade system search results record corresponding to the given grade system 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

getGradeSystems

GradeSystemList getGradeSystems()

Gets the grade system list resulting from the search.

Returns:

the grade system list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getGradeSystemQueryInspector

GradeSystemQueryInspector getGradeSystemQueryInspector()

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

Returns:

the grade system query inspector

Compliance:

mandatory - This method must be implemented.

getGradeSystemSearchResultsRecord

GradeSystemSearchResultsRecord getGradeSystemSearchResultsRecord(Type gradeSystemSearchRecordType)
                                                          throws OperationFailedException

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

Throws:

NullArgumentException - gradeSystemSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(gradeSystemSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.