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

Modifier and Type	Method	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 .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

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.