public interface IntersectionSmartMapSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. An IntersectionQuery
can be retrieved from this
session and mapped to this Map
to create a virtual
collection of Intersections.
The intersections may be
sequenced using the IntersectionSearchOrder
from this
session.
This Map
has a default query that matches any
intersection and a default search order that specifies no sequencing. The
queries may be examined using an IntersectionQueryInspector.
The query may be modified by converting the inspector back to an
IntersectionQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyIntersectionQuery(IntersectionQuery intersectionQuery)
Applies an intersection query to this map.
|
void |
applyIntersectionSequencing(IntersectionSearchOrder intersectionSearchOrder)
Applies an intersection search order to this map.
|
boolean |
canManageSmartMaps()
Tests if this user can manage smart maps.
|
IntersectionQuery |
getIntersectionQuery()
Gets an intersection query.
|
IntersectionQuery |
getIntersectionQueryFromInspector(IntersectionQueryInspector intersectionQueryInspector)
Gets an intersection query from an inspector.
|
IntersectionSearchOrder |
getIntersectionSearchOrder()
Gets an intersection search order.
|
Map |
getMap()
Gets the
Map associated with this session. |
Id |
getMapId()
Gets the
Map Id associated with this
session. |
IntersectionQueryInspector |
inspectIntersectionQuery()
Gets an intersection query inspector for this map.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getMapId()
Map
Id
associated with this
session. Map Id
associated with this sessionmandatory
- This method must be implemented. Map getMap() throws OperationFailedException, PermissionDeniedException
Map
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSmartMaps()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart map management is not
authorized, true
otherwisemandatory
- This method must be implemented. IntersectionQuery getIntersectionQuery()
mandatory
- This method must be implemented. IntersectionSearchOrder getIntersectionSearchOrder()
mandatory
- This method must be implemented. void applyIntersectionQuery(IntersectionQuery intersectionQuery) throws OperationFailedException, PermissionDeniedException
intersectionQuery
- the intersection queryNullArgumentException
- intersectionQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- intersectionQuery
not of this servicemandatory
- This method must be implemented. IntersectionQueryInspector inspectIntersectionQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyIntersectionSequencing(IntersectionSearchOrder intersectionSearchOrder) throws OperationFailedException, PermissionDeniedException
intersectionSearchOrder
- the intersection search orderNullArgumentException
- intersectionSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- intersectionsearchOrder
not of this servicemandatory
- This method must be implemented. IntersectionQuery getIntersectionQueryFromInspector(IntersectionQueryInspector intersectionQueryInspector)
intersectionQueryInspector
- an intersection query inspectorNullArgumentException
-
intersectionQueryInspector
is null
UnsupportedException
-
intersectionQueryInspector
is not of this servicemandatory
- This method must be implemented.