org.osid.mapping.path

Interface ObstacleSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, ObstacleQuerySession, 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

Methods

Modifier and Type	Method and 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 org.osid.mapping.path.ObstacleQuerySession

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

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.