public interface SignalQuerySession extends OsidSession
This session provides methods for searching among Signal
objects. The search query is constructed using the SignalQuery.
This session defines views that offer differing behaviors for searching.
Signals may have a query record indicated by their respective record
types. The query record is accessed via the SignalQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchSignals()
Tests if this user can perform
Signal lookups. |
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.
|
SignalList |
getSignalsByQuery(SignalQuery signalQuery)
Gets a list of
Signals matching the given signal query. |
void |
useFederatedMapView()
Federates the view for methods in this session.
|
void |
useIsolatedMapView()
Isolates the view for methods in this session.
|
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 canSearchSignals()
Signal
lookups. A return
of true does not guarantee successful authorization. A return of false
indicates that it is known all methods in this session will result in
a PERMISSION_DENIED.
This is intended as a hint to an
application that may not offer lookup operations to unauthorized
users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedMapView()
mandatory
- This method is must be implemented. void useIsolatedMapView()
mandatory
- This method is must be implemented. SignalQuery getSignalQuery()
mandatory
- This method must be implemented. SignalList getSignalsByQuery(SignalQuery signalQuery) throws OperationFailedException, PermissionDeniedException
Signals
matching the given signal query.signalQuery
- the signal query SignalList
NullArgumentException
- signalQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- signalQuery
is
not of this servicemandatory
- This method must be implemented.