Interface SceneSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface SceneSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
SceneQueryInspector	getSceneQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
SceneList	getScenes()	Gets the scene list resulting from a search.
SceneSearchResultsRecord	getSceneSearchResultsRecord(Type sceneSearchRecordType)	Gets the scene search results record corresponding to the given scene 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

getScenes

SceneList getScenes()

Gets the scene list resulting from a search.

Returns:

the scene list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getSceneQueryInspector

SceneQueryInspector getSceneQueryInspector()

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

Returns:

the scene query inspector

Compliance:

mandatory - This method must be implemented.

getSceneSearchResultsRecord

SceneSearchResultsRecord getSceneSearchResultsRecord(Type sceneSearchRecordType)
                                              throws OperationFailedException

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

Parameters:

sceneSearchRecordType - a scene search record type

Returns:

the scene search results record

Throws:

NullArgumentException - sceneSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(sceneSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.