public interface MapSearchSession extends MapQuerySession
This session provides methods for searching among Map
objects. The search query is constructed using the MapQuery.
getMapsByQuery()
is the basic search method and returns
a list of Maps.
A more advanced search may be performed
with getMapsBySearch().
It accepts a MapSearch
in addition to the query for the purpose of specifying additional
options affecting the entire search, such as ordering.
getMapsBySearch()
returns a MapSearchResults
that
can be used to access the resulting MapList
or be used to
perform a search within the result set through MapSearch.
Maps may have a query record indicated by their respective record
types. The query record is accessed via the MapQuery.
Modifier and Type | Method and Description |
---|---|
MapQuery |
getMapQueryFromInspector(MapQueryInspector mapQueryInspector)
Gets a map query from an inspector.
|
MapSearchResults |
getMapsBySearch(MapQuery mapQuery,
MapSearch mapSearch)
Gets the search results matching the given search query using the
given search.
|
MapSearch |
getMapSearch()
Gets a map search.
|
MapSearchOrder |
getMapSearchOrder()
Gets a map search order.
|
canSearchMaps, getMapQuery, getMapsByQuery
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
MapSearch getMapSearch()
mandatory
- This method must be implemented. MapSearchOrder getMapSearchOrder()
MapSearchOrder
is supplied
to a MapSearch
to specify the ordering of results.mandatory
- This method must be implemented. MapSearchResults getMapsBySearch(MapQuery mapQuery, MapSearch mapSearch) throws OperationFailedException, PermissionDeniedException
mapQuery
- the map querymapSearch
- the map searchNullArgumentException
- mapQuery
or
mapSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- mapQuery
or
mapSearch
is not of this servicemandatory
- This method must be implemented. MapQuery getMapQueryFromInspector(MapQueryInspector mapQueryInspector)
MapSearchResults.
mapQueryInspector
- a map query inspectorNullArgumentException
- mapQueryInspector
is null
UnsupportedException
- mapQueryInspector
is not of this servicemandatory
- This method must be implemented.