Interface EngineSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface EngineSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
EngineQueryInspector	getEngineQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
EngineList	getEngines()	Gets the engine list resulting from a search.
EngineSearchResultsRecord	getEngineSearchResultsRecord(Type engineSearchRecordType)	Gets the engine search results record corresponding to the given engine search record Type.

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

getEngines

EngineList getEngines()

Gets the engine list resulting from a search. This is a retrieve-once method. Another list may be created through performing another search.

Returns:

the engine list

Throws:

IllegalStateException - the engine list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getEngineQueryInspector

EngineQueryInspector getEngineQueryInspector()

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

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getEngineSearchResultsRecord

EngineSearchResultsRecord getEngineSearchResultsRecord(Type engineSearchRecordType)
                                                throws OperationFailedException,
PermissionDeniedException

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

Parameters:

engineSearchRecordType - an engine search record type

Returns:

the engine search results record

Throws:

NullArgumentException - EngineSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(engineSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.