Interface ObstacleSearchSession

All Superinterfaces:

AutoCloseable, Closeable, ObstacleQuerySession, OsidSession, OsidSession

public interface ObstacleSearchSession
extends ObstacleQuerySession

This session provides methods for searching among Obstacle objects. The search query is constructed using the ObstacleQuery .

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

This session defines views that offer differing behaviors for searching.

• federated map view: searches include obstacle in maps of which this map is an ancestor in the map hierarchy
• isolated map view: searches are restricted to obstacle in this map

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

Method Summary

Modifier and Type	Method	Description
ObstacleQuery	getObstacleQueryFromInspector(ObstacleQueryInspector obstacleQueryInspector)	Gets an obstacle query from an inspector.
ObstacleSearchResults	getObstaclesBySearch(ObstacleQuery obstacleQuery, ObstacleSearch obstacleSearch)	Gets the search results matching the given search query using the given search.
ObstacleSearch	getObstacleSearch()	Gets an obstacle search.
ObstacleSearchOrder	getObstacleSearchOrder()	Gets an obstacle search order.

Methods inherited from interface Closeable

close

Methods inherited from interface ObstacleQuerySession

canSearchObstacles, getMap, getMapId, getObstacleQuery, getObstaclesByQuery, useFederatedMapView, useIsolatedMapView

Modifier and Type	Method	Description
boolean	canSearchObstacles()	Tests if this user can perform Obstacle lookups.
Map	getMap()	Gets the Map associated with this session.
Id	getMapId()	Gets the Map Id associated with this session.
ObstacleQuery	getObstacleQuery()	Gets an obstacle query.
ObstacleList	getObstaclesByQuery(ObstacleQuery obstacleQuery)	Gets a list of Obstacles matching the given obstacle search.
void	useFederatedMapView()	Federates the view for methods in this session.
void	useIsolatedMapView()	Isolates the view for methods in this session.

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.

Method Details

getObstacleSearch

ObstacleSearch getObstacleSearch()

Gets an obstacle search.

Returns:

the obstacle search

Compliance:

mandatory - This method must be implemented.

getObstacleSearchOrder

ObstacleSearchOrder getObstacleSearchOrder()

Gets an obstacle search order. The ObstacleSearchOrder is supplied to an ObstacleSearch to specify the ordering of results.

Returns:

the obstacle search order

Compliance:

mandatory - This method must be implemented.

getObstaclesBySearch

ObstacleSearchResults getObstaclesBySearch(ObstacleQuery obstacleQuery,
 ObstacleSearch obstacleSearch)
                                    throws OperationFailedException,
PermissionDeniedException

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

Parameters:

obstacleQuery - the obstacle query

obstacleSearch - the obstacle search

Returns:

the returned search results

Throws:

NullArgumentException - obstacleQuery or obstacleSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - obstacleQuery or obstacleSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getObstacleQueryFromInspector

ObstacleQuery getObstacleQueryFromInspector(ObstacleQueryInspector obstacleQueryInspector)

Gets an obstacle query from an inspector. The inspector is available from an ObstacleSearchResults .

Parameters:

obstacleQueryInspector - an obstacle query inspector

Returns:

the obstacle query

Throws:

NullArgumentException - obstacleQueryInspector is null

UnsupportedException - obstacleQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.