Interface GradeEntrySearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface GradeEntrySearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
GradeEntryList	getGradeEntries()	Gets the package list resulting from the search.
GradeEntryQueryInspector	getGradeEntryQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
GradeEntrySearchResultsRecord	getGradeEntrySearchResultsRecord(Type gradeEntrySearchRecordType)	Gets the grade entry search results record corresponding to the given grade entry 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

getGradeEntries

GradeEntryList getGradeEntries()

Gets the package list resulting from the search.

Returns:

the grade entry list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getGradeEntryQueryInspector

GradeEntryQueryInspector getGradeEntryQueryInspector()

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

Returns:

the grade entry query inspector

Compliance:

mandatory - This method must be implemented.

getGradeEntrySearchResultsRecord

GradeEntrySearchResultsRecord getGradeEntrySearchResultsRecord(Type gradeEntrySearchRecordType)
                                                        throws OperationFailedException

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

Parameters:

gradeEntrySearchRecordType - a grade entry search record type

Returns:

the grade entry search results record

Throws:

NullArgumentException - gradeEntrySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(gradeEntrySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.