public interface SignalSmartMapSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A SignalQuery
can be retrieved from this session
and mapped to this Map
to create a virtual collection of
Signals.
The signals may be sequenced using the
SignalSearchOrder
from this session.
This Map
has a default query that matches any signal
and a default search order that specifies no sequencing. The queries may
be examined using a SignalQueryInspector.
The query may be
modified by converting the inspector back to a SignalQuery.
Modifier and Type | Method and Description |
---|---|
void |
applySignalQuery(SignalQuery signalQuery)
Applies a signal query to this map.
|
void |
applySignalSequencing(SignalSearchOrder signalSearchOrder)
Applies a signal 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. |
SignalQuery |
getSignalQuery()
Gets a signal query.
|
SignalQuery |
getSignalQueryFromInspector(SignalQueryInspector signalQueryInspector)
Gets a signal query from an inspector.
|
SignalSearchOrder |
getSignalSearchOrder()
Gets a signal search order.
|
SignalQueryInspector |
inspecSignalQuery()
Gets a signal 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. SignalQuery getSignalQuery()
mandatory
- This method must be implemented. SignalSearchOrder getSignalSearchOrder()
mandatory
- the signal search order void applySignalQuery(SignalQuery signalQuery) throws OperationFailedException, PermissionDeniedException
signalQuery
- the signal queryNullArgumentException
- signalQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- signalQuery
not
of this servicemandatory
- This method must be implemented. SignalQueryInspector inspecSignalQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applySignalSequencing(SignalSearchOrder signalSearchOrder) throws OperationFailedException, PermissionDeniedException
signalSearchOrder
- the signal search orderNullArgumentException
- signalSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- signalSearchOrder
not of this servicemandatory
- This method must be implemented. SignalQuery getSignalQueryFromInspector(SignalQueryInspector signalQueryInspector)
signalQueryInspector
- a signal query inspectorNullArgumentException
- signalQueryInspector
is null
UnsupportedException
- signalQueryInspector
is not of this servicemandatory
- This method must be implemented.