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.
Intersections may have a query record indicated by their respective
record types. The query record is accessed via the
IntersectionQuery.
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.
|
canSearchIntersections, getIntersectionQuery, getIntersectionsByQuery, getMap, getMapId, useFederatedMapView, useIsolatedMapView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
IntersectionSearch getIntersectionSearch()
mandatory
- This method must be implemented. IntersectionSearchOrder getIntersectionSearchOrder()
IntersectionSearchOrder
is supplied to an IntersectionSearch
to specify
the ordering of results.mandatory
- This method must be implemented. IntersectionSearchResults getIntersectionsBySearch(IntersectionQuery intersectionQuery, IntersectionSearch intersectionSearch) throws OperationFailedException, PermissionDeniedException
intersectionQuery
- the intersection queryintersectionSearch
- the intersection searchNullArgumentException
- intersectionQuery
or intersectionSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- intersectionQuery
or intersectionSearch
is not of this servicemandatory
- This method must be implemented. IntersectionQuery getIntersectionQueryFromInspector(IntersectionQueryInspector intersectionQueryInspector)
IntersectionSearchResults.
intersectionQueryInspector
- an intersection query inspectorNullArgumentException
-
intersectionQueryInspector
is null
UnsupportedException
-
intersectionQueryInspector
is not of this servicemandatory
- This method must be implemented.