org.osid.mapping.path

Interface IntersectionSearchSession

All Superinterfaces:

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

public interface IntersectionSearchSession
extends IntersectionQuerySession

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

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

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Methods

Modifier and Type	Method and Description
IntersectionQuery	getIntersectionQueryFromInspector(IntersectionQueryInspector intersectionQueryInspector) Gets an intersection query from an inspector.
IntersectionSearchResults	getIntersectionsBySearch(IntersectionQuery intersectionQuery, IntersectionSearch intersectionSearch) Gets the search results matching the given search query using the given search.
IntersectionSearch	getIntersectionSearch() Gets an intersection search.
IntersectionSearchOrder	getIntersectionSearchOrder() Gets an intersection search order.

Methods inherited from interface org.osid.mapping.path.IntersectionQuerySession

canSearchIntersections, getIntersectionQuery, getIntersectionsByQuery, getMap, getMapId, 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

getIntersectionSearch

IntersectionSearch getIntersectionSearch()

Gets an intersection search.

Returns:

the intersection search

Compliance:

mandatory - This method must be implemented.

getIntersectionSearchOrder

IntersectionSearchOrder getIntersectionSearchOrder()

Gets an intersection search order. The IntersectionSearchOrder is supplied to an IntersectionSearch to specify the ordering of results.

Returns:

the intersection search order

Compliance:

mandatory - This method must be implemented.

getIntersectionsBySearch

IntersectionSearchResults getIntersectionsBySearch(IntersectionQuery intersectionQuery,
                                                 IntersectionSearch intersectionSearch)
                                                   throws OperationFailedException,
                                                          PermissionDeniedException

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

Parameters:

intersectionQuery - the intersection query

intersectionSearch - the intersection search

Returns:

the returned search results

Throws:

NullArgumentException - intersectionQuery or intersectionSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - intersectionQuery or intersectionSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getIntersectionQueryFromInspector

IntersectionQuery getIntersectionQueryFromInspector(IntersectionQueryInspector intersectionQueryInspector)

Gets an intersection query from an inspector. The inspector is available from an IntersectionSearchResults.

Parameters:

intersectionQueryInspector - an intersection query inspector

Returns:

the intersection query

Throws:

NullArgumentException - intersectionQueryInspector is null

UnsupportedException - intersectionQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.