public interface ObstacleSmartMapSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. An ObstacleQuery
can be retrieved from this
session and mapped to this Map
to create a virtual
collection of Obstacles.
The obstacle may be sequenced
using the ObstacleSearchOrder
from this session.
This Map
has a default query that matches any obstacle
and a default search order that specifies no sequencing. The queries may
be examined using an ObstacleQueryInspector.
The query may
be modified by converting the inspector back to an ObstacleQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyObstacleQuery(ObstacleQuery obstacleQuery)
Applies an obstacle query to this map.
|
void |
applyObstacleSequencing(ObstacleSearchOrder obstacleSearchOrder)
Applies an obstacle search order to this map.
|
boolean |
canManageSmartMaps()
Tests if this user can manage smart maps.
|
Map |
getMap()
Gets the
Map associated with this session. |
Id |
getMapId()
Gets the
Map Id associated with this
session. |
ObstacleQuery |
getObstacleQuery()
Gets an obstacle query.
|
ObstacleQuery |
getObstacleQueryFromInspector(ObstacleQueryInspector obstacleQueryInspector)
Gets an obstacle query from an inspector.
|
ObstacleSearchOrder |
getObstacleSearchOrder()
Gets an obstacle search order.
|
ObstacleQueryInspector |
inspecObstacleQuery()
Gets an obstacle 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. ObstacleQuery getObstacleQuery()
mandatory
- This method must be implemented. ObstacleSearchOrder getObstacleSearchOrder()
mandatory
- This method must be implemented. void applyObstacleQuery(ObstacleQuery obstacleQuery) throws OperationFailedException, PermissionDeniedException
obstacleQuery
- the obstacle queryNullArgumentException
- obstacleQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- obstacleQuery
not
of this servicemandatory
- This method must be implemented. ObstacleQueryInspector inspecObstacleQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyObstacleSequencing(ObstacleSearchOrder obstacleSearchOrder) throws OperationFailedException, PermissionDeniedException
obstacleSearchOrder
- the obstacle search orderNullArgumentException
- obstacleSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- obstacleSearchOrder
not of this servicemandatory
- This method must be implemented. ObstacleQuery getObstacleQueryFromInspector(ObstacleQueryInspector obstacleQueryInspector)
obstacleQueryInspector
- an obstacle query inspectorNullArgumentException
- obstacleQueryInspector
is null
UnsupportedException
- obstacleQueryInspector
is not of this servicemandatory
- This method must be implemented.