public interface ObstacleEnablerRuleLookupSession extends OsidSession
This session provides methods to retrieve ObstacleEnabler
to Obstacle
mappings. An Obstacle
with multiple ObstacleEnablers
means any positive rule
evaluation across the enablers result in an enabled Obstacle.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupObstacleEnablerRules()
Tests if this user can perform lookups of obstacle enabler/obstacle
mappings.
|
Map |
getMap()
Gets the
Map associated with this session. |
Id |
getMapId()
Gets the
Map Id associated with this
session. |
IdList |
getObstacleEnablerIdsForObstacle(Id obstacleId)
Gets the
ObstacleEnabler Id associated with an
Obstacle. |
ObstacleEnablerList |
getObstacleEnablersForObstacle(Id obstacleId)
Gets the
ObstacleEnabler associated with an
Obstacle. |
IdList |
getObstacleIdsForObstacleEnabler(Id obstacleEnablerId)
Gets the
Obstacle Ids mapped to an
ObstacleEnabler. |
ObstacleList |
getObstaclesForObstacleEnabler(Id obstacleEnablerId)
Gets the
Obstacles mapped to an ObstacleEnabler. |
void |
useComparativeObstacleEnablerRuleView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
useFederatedMapView()
Federates the view for methods in this session.
|
void |
useIsolatedMapView()
Isolates the view for methods in this session.
|
void |
usePlenaryObstacleEnablerRuleView()
A complete view of the
ObstacleEnabler and
Obstacle returns is desired. |
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 canLookupObstacleEnablerRules()
PERMISSION_DENIED.
This is intended as a hint to an application that may opt not
to offer lookup operations to unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeObstacleEnablerRuleView()
mandatory
- This method is must be implemented. void usePlenaryObstacleEnablerRuleView()
ObstacleEnabler
and
Obstacle
returns is desired. Methods will return what is
requested or result in an error. This view is used when greater
precision is desired at the expense of interoperability.mandatory
- This method is must be implemented. void useFederatedMapView()
mandatory
- This method is must be implemented. void useIsolatedMapView()
mandatory
- This method is must be implemented. IdList getObstacleEnablerIdsForObstacle(Id obstacleId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ObstacleEnabler Id
associated with an
Obstacle.
obstacleId
- Id
of the Obstacle
Ids
NotFoundException
- obstacleId
is not
foundNullArgumentException
- obstacleId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ObstacleEnablerList getObstacleEnablersForObstacle(Id obstacleId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ObstacleEnabler
associated with an
Obstacle.
obstacleId
- Id
of the Obstacle
NotFoundException
- obstacleId
is not
foundNullArgumentException
- obstacleId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getObstacleIdsForObstacleEnabler(Id obstacleEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Obstacle
Ids
mapped to an
ObstacleEnabler.
obstacleEnablerId
- Id
of an
ObstacleEnabler
Ids
NotFoundException
- obstacleEnablerId
is
not foundNullArgumentException
- obstacleEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ObstacleList getObstaclesForObstacleEnabler(Id obstacleEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Obstacles
mapped to an ObstacleEnabler.
obstacleEnablerId
- Id
of an
ObstacleEnabler
NotFoundException
- obstacleEnablerId
is
not foundNullArgumentException
- obstacleEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.