public interface ObstacleEnablerQuerySession extends OsidSession
This session provides methods for searching among
ObstacleEnabler
objects. The search query is constructed using the
ObstacleEnablerQuery.
This session defines views that offer differing behaviors for searching.
obstacle enabler may have a query record indicated by their respective
record types. The query record is accessed via the
ObstacleEnablerQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchObstacleEnablers()
Tests if this user can perform
ObstacleEnabler lookups. |
Map |
getMap()
Gets the
Map associated with this session. |
Id |
getMapId()
Gets the
Map Id associated with this
session. |
ObstacleEnablerQuery |
getObstacleEnablerQuery()
Gets an obstacle enabler query.
|
ObstacleEnablerList |
getObstacleEnablersByQuery(ObstacleEnablerQuery obstacleEnablerQuery)
Gets a list of
ObstacleEnablers matching the given
obstacle 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 canSearchObstacleEnablers()
ObstacleEnabler
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. ObstacleEnablerQuery getObstacleEnablerQuery()
mandatory
- This method must be implemented. ObstacleEnablerList getObstacleEnablersByQuery(ObstacleEnablerQuery obstacleEnablerQuery) throws OperationFailedException, PermissionDeniedException
ObstacleEnablers
matching the given
obstacle enabler query.obstacleEnablerQuery
- the obstacle enabler query ObstacleEnablerList
NullArgumentException
- obstacleEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- obstacleEnablerQuery
is not of this servicemandatory
- This method must be implemented.