public interface SignalEnablerQuerySession extends OsidSession
This session provides methods for searching among SignalEnabler
objects. The search query is constructed using the
SignalEnablerQuery.
This session defines views that offer differing behaviors for searching.
signal enabler may have a query record indicated by their respective
record types. The query record is accessed via the
SignalEnablerQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchSignalEnablers()
Tests if this user can perform
SignalEnabler lookups. |
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.
|
SignalEnablerList |
getSignalEnablersByQuery(SignalEnablerQuery signalEnablerQuery)
Gets a list of
SignalEnablers matching the given signal
enabler 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 canSearchSignalEnablers()
SignalEnabler
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. SignalEnablerQuery getSignalEnablerQuery()
mandatory
- This method must be implemented. SignalEnablerList getSignalEnablersByQuery(SignalEnablerQuery signalEnablerQuery) throws OperationFailedException, PermissionDeniedException
SignalEnablers
matching the given signal
enabler query.signalEnablerQuery
- the signal enabler query SignalEnablerList
NullArgumentException
- signalEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- signalEnablerQuery
is not of this servicemandatory
- This method must be implemented.