Interface SceneSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, SceneQuerySession

public interface SceneSearchSession
extends SceneQuerySession

This session provides methods for searching among Scenes . The search query is constructed using the SceneQuery .

getScenesByQuery() is the basic search method and returns a list of Scenes . A more advanced search may be performed with getScenesBySearch() . It accepts an SceneSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getScenesBySearch() returns an SceneSearchResults that can be used to access the resulting SceneList or be used to perform a search within the result set through SceneSearch .

This session defines views that offer differing behaviors for searching.

• federated system view: searches include scenes in systems of which this system is an ancestor in the system hierarchy
• isolated system view: searches are restricted to scenes in this system

Scenes may have a query record indicated by their respective record types. The query record is accessed via the SceneQuery .

Method Summary

Modifier and Type	Method	Description
SceneQuery	getSceneQueryFromInspector(SceneQueryInspector sceneQueryInspector)	Gets a scene query from an inspector.
SceneSearchResults	getScenesBySearch(SceneQuery sceneQuery, SceneSearch sceneSearch)	Gets the search results matching the given search query using the given search.
SceneSearch	getSceneSearch()	Gets a scene search.
SceneSearchOrder	getSceneSearchOrder()	Gets a scene search order.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Methods inherited from interface SceneQuerySession

canSearchScenes, getSceneQuery, getScenesByQuery, getSystem, getSystemId, useFederatedSystemView, useIsolatedSystemView

Modifier and Type	Method	Description
boolean	canSearchScenes()	Tests if this user can perform Scene lookups.
SceneQuery	getSceneQuery()	Gets a scene query.
SceneList	getScenesByQuery(SceneQuery sceneQuery)	Gets a list of Scenes matching the given scene query.
System	getSystem()	Gets the System associated with this session.
Id	getSystemId()	Gets the System Id associated with this session.
void	useFederatedSystemView()	Federates the view for methods in this session.
void	useIsolatedSystemView()	Isolates the view for methods in this session.

Method Details

getSceneSearch

SceneSearch getSceneSearch()

Gets a scene search.

Returns:

the scene search

Compliance:

mandatory - This method must be implemented.

getSceneSearchOrder

SceneSearchOrder getSceneSearchOrder()

Gets a scene search order. The SceneSearchOrder is supplied to a SceneSearch to specify the ordering of results.

Returns:

the scene search order

Compliance:

mandatory - This method must be implemented.

getScenesBySearch

SceneSearchResults getScenesBySearch(SceneQuery sceneQuery,
 SceneSearch sceneSearch)
                              throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

sceneQuery - the scene query

sceneSearch - the scene search

Returns:

the returned search results

Throws:

NullArgumentException - sceneQuery or sceneSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - sceneQuery or sceneSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getSceneQueryFromInspector

SceneQuery getSceneQueryFromInspector(SceneQueryInspector sceneQueryInspector)

Gets a scene query from an inspector. The inspector is available from a SceneSearchResults .

Parameters:

sceneQueryInspector - a scene query inspector

Returns:

the scene query

Throws:

NullArgumentException - sceneQueryInspector is null

UnsupportedException - sceneQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.