org.osid.mapping.path.rules

Interface ObstacleEnablerSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, ObstacleEnablerQuerySession, OsidSession

public interface ObstacleEnablerSearchSession
extends ObstacleEnablerQuerySession

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

getObstacleEnablersByQuery() is the basic search method and returns a list of ObstacleEnablers. A more advanced search may be performed with getObstacleEnablersBySearch(). It accepts an ObstacleEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as mapping. getObstacleEnablersBySearch() returns an ObstacleEnablerSearchResults that can be used to access the resulting ObstacleEnablerList or be used to perform a search within the result set through ObstacleEnablerSearch.

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Methods

Modifier and Type	Method and Description
ObstacleEnablerQuery	getObstacleEnablerQueryFromInspector(ObstacleEnablerQueryInspector obstacleEnablerQueryInspector) Gets an obstacle enabler query from an inspector.
ObstacleEnablerSearchResults	getObstacleEnablersBySearch(ObstacleEnablerQuery obstacleEnablerQuery, ObstacleEnablerSearch obstacleEnablerSearch) Gets the search results matching the given search query using the given search.
ObstacleEnablerSearch	getObstacleEnablerSearch() Gets an obstacle enabler search.
ObstacleEnablerSearchOrder	getObstacleEnablerSearchOrder() Gets an obstacle enabler search order.

Methods inherited from interface org.osid.mapping.path.rules.ObstacleEnablerQuerySession

canSearchObstacleEnablers, getMap, getMapId, getObstacleEnablerQuery, getObstacleEnablersByQuery, 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

getObstacleEnablerSearch

ObstacleEnablerSearch getObstacleEnablerSearch()

Gets an obstacle enabler search.

Returns:

the obstacle enabler search

Compliance:

mandatory - This method must be implemented.

getObstacleEnablerSearchOrder

ObstacleEnablerSearchOrder getObstacleEnablerSearchOrder()

Gets an obstacle enabler search order. The ObstacleEnablerSearchOrder is supplied to an ObstacleEnablerSearch to specify the ordering of results.

Returns:

the obstacle enabler search order

Compliance:

mandatory - This method must be implemented.

getObstacleEnablersBySearch

ObstacleEnablerSearchResults getObstacleEnablersBySearch(ObstacleEnablerQuery obstacleEnablerQuery,
                                                       ObstacleEnablerSearch obstacleEnablerSearch)
                                                         throws OperationFailedException,
                                                                PermissionDeniedException

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

Parameters:

obstacleEnablerQuery - the obstacle enabler query

obstacleEnablerSearch - the obstacle enabler search

Returns:

the returned search results

Throws:

NullArgumentException - obstacleEnablerQuery or obstacleEnablerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - obstacleEnablerQuery or obstacleEnablerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getObstacleEnablerQueryFromInspector

ObstacleEnablerQuery getObstacleEnablerQueryFromInspector(ObstacleEnablerQueryInspector obstacleEnablerQueryInspector)

Gets an obstacle enabler query from an inspector. The inspector is available from an ObstacleEnablerSearchResults.

Parameters:

obstacleEnablerQueryInspector - an obstacle enabler query inspector

Returns:

the obstacle enabler query

Throws:

NullArgumentException - obstacleEnablerQueryInspector is null

UnsupportedException - obstacleEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.