org.osid.grading

Interface GradebookColumnSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface GradebookColumnSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
GradebookColumnQueryInspector	getGradebookColumnQueryInspector() Gets the inspector for the query to examine the terms used in the search.
GradebookColumnList	getGradebookColumns() Gets the gradebook column list resulting from the search.
GradebookColumnSearchResultsRecord	getGradebookColumnSearchResultsRecord(Type gradebookColumnSearchRecordType) Gets the gradebook column search results record corresponding to the given gradebook column 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

getGradebookColumns

GradebookColumnList getGradebookColumns()

Gets the gradebook column list resulting from the search.

Returns:

the gradebook column list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getGradebookColumnQueryInspector

GradebookColumnQueryInspector getGradebookColumnQueryInspector()

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

Returns:

the gradebook column query inspector

Compliance:

mandatory - This method must be implemented.

getGradebookColumnSearchResultsRecord

GradebookColumnSearchResultsRecord getGradebookColumnSearchResultsRecord(Type gradebookColumnSearchRecordType)
                                                                         throws OperationFailedException

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

Parameters:

gradebookColumnSearchRecordType - a gradebook column search record type

Returns:

the gradebook column search results record

Throws:

NullArgumentException - gradebookColumnSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(gradebookColumnSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.