public interface SignalEnablerSmartMapSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
maps. A SignalEnablerQuery
can be retrieved from this
session and mapped to this Map
to create a virtual
collection of signal enablers. The signal enabler may be sequenced using
the SignalEnablerSearchOrder
from this session.
This Map
has a default query that matches any signal
enabler and a default search order that specifies no sequencing. The
queries may be examined using a SignalEnablerQueryInspector.
The query may be modified by converting the inspector back to a
SignalEnablerQuery.
Modifier and Type | Method and Description |
---|---|
void |
applySignalEnablerQuery(SignalEnablerQuery signalEnablerQuery)
Applies a signal enabler query to this map.
|
void |
applySignalEnablerSequencing(SignalEnablerSearchOrder signalEnablerSearchOrder)
Applies a signal enabler 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. |
SignalEnablerQuery |
getSignalEnablerQuery()
Gets a signal enabler query.
|
SignalEnablerQuery |
getSignalEnablerQueryFromInspector(SignalEnablerQueryInspector signalEnablerQueryInspector)
Gets a signal enabler query from an inspector.
|
SignalEnablerSearchOrder |
getSignalEnablerSearchOrder()
Gets a signal enabler search order.
|
SignalEnablerQueryInspector |
inspectSignalEnablerQuery()
Gets a signal enabler 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. SignalEnablerQuery getSignalEnablerQuery()
mandatory
- This method must be implemented. SignalEnablerSearchOrder getSignalEnablerSearchOrder()
mandatory
- This method must be implemented. void applySignalEnablerQuery(SignalEnablerQuery signalEnablerQuery) throws OperationFailedException, PermissionDeniedException
signalEnablerQuery
- the signal enabler queryNullArgumentException
- signalEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- signalEnablerQuery
not of this servicemandatory
- This method must be implemented. SignalEnablerQueryInspector inspectSignalEnablerQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applySignalEnablerSequencing(SignalEnablerSearchOrder signalEnablerSearchOrder) throws OperationFailedException, PermissionDeniedException
signalEnablerSearchOrder
- the signal enabler search orderNullArgumentException
- signalEnablerSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- signalEnablerSearchOrder
not of this servicemandatory
- This method must be implemented. SignalEnablerQuery getSignalEnablerQueryFromInspector(SignalEnablerQueryInspector signalEnablerQueryInspector)
signalEnablerQueryInspector
- a signal enabler query inspectorNullArgumentException
-
signalEnablerQueryInspector
is null
UnsupportedException
-
signalEnablerQueryInspector
is not of this servicemandatory
- This method must be implemented.