org.osid.control

Interface ControllerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ControllerSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
ControllerQueryInspector	getControllerQueryInspector() Gets the inspector for the query to examine the terms used in the search.
ControllerList	getControllers() Gets the controller list resulting from a search.
ControllerSearchResultsRecord	getControllerSearchResultsRecord(Type controllerSearchRecordType) Gets the controller search results record corresponding to the given controller 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

getControllers

ControllerList getControllers()

Gets the controller list resulting from a search.

Returns:

the controller list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getControllerQueryInspector

ControllerQueryInspector getControllerQueryInspector()

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

Returns:

the controller query inspector

Compliance:

mandatory - This method must be implemented.

getControllerSearchResultsRecord

ControllerSearchResultsRecord getControllerSearchResultsRecord(Type controllerSearchRecordType)
                                                               throws OperationFailedException

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

Parameters:

controllerSearchRecordType - a controller search record type

Returns:

the controller search results record

Throws:

NullArgumentException - controllerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(controllerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.