org.osid.grading

Interface GradebookSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface GradebookSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
GradebookQueryInspector	getGradebookQueryInspector() Gets the inspector for the query to examine the terms used in the search.
GradebookList	getGradebooks() Gets the gradebook list resulting from the search.
GradebookSearchResultsRecord	getGradebookSearchResultsRecord(Type gradebookSearchRecordType) Gets the gradebook search results record corresponding to the given gradebook search record Type.

Methods inherited from interface org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getGradebooks

GradebookList getGradebooks()

Gets the gradebook list resulting from the search.

Returns:

the gradebook list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getGradebookQueryInspector

GradebookQueryInspector getGradebookQueryInspector()

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

Returns:

the gradebook query inspector

Compliance:

mandatory - This method must be implemented.

getGradebookSearchResultsRecord

GradebookSearchResultsRecord getGradebookSearchResultsRecord(Type gradebookSearchRecordType)
                                                             throws OperationFailedException

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

Parameters:

gradebookSearchRecordType - a gradebook search record type

Returns:

the gradebook search results record

Throws:

NullArgumentException - gradebookSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(gradebookSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.