public interface ObstacleEnablerRuleApplicationSession extends OsidSession
This session provides methods to apply ObstacleEnablers
to Obstacles.
An Obstacle
with multiple
ObstacleEnablers
means any positive rule evaluation across
the enablers result in an enabled Obstacle.
Modifier and Type | Method and Description |
---|---|
void |
assignObstacleEnablerToObstacle(Id obstacleEnablerId,
Id obstacleId)
Adds an existing
ObstacleEnabler to an Obstacle. |
boolean |
canAssignObstacleEnablers()
Tests if this user can alter obstacle enabler/obstacle mappings.
|
boolean |
canSequenceObstacleEnablers()
Tests if this user can order
ObstacleEnablers. |
Map |
getMap()
Gets the
Map associated with this session. |
Id |
getMapId()
Gets the
Map Id associated with this
session. |
void |
moveObstacleEnablerAhead(Id obstacleEnablerId,
Id obstacleId,
Id referenceId)
Reorders obstacle enablers for an obstacle by moving the specified
obstacle enabler in front of a reference obstacle enabler.
|
void |
moveObstacleEnablerBehind(Id obstacleEnablerId,
Id obstacleId,
Id referenceId)
Reorders obstacle enablers for an obstacle by moving the specified
obstacle enabler behind a reference obstacle enabler.
|
void |
orderObstacleEnablers(Id[] obstacleEnablerIds,
Id obstacleId)
Reorders a set of obstacle enablers for an obstacle.
|
void |
unassignObstacleEnablerFromObstacle(Id obstacleEnablerId,
Id obstacleId)
Removes an
ObstacleEnabler from an Obstacle. |
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 canAssignObstacleEnablers()
PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer lookup operations
to unauthorized users. false
if mapping is not authorized, true
otherwisemandatory
- This method must be implemented. void assignObstacleEnablerToObstacle(Id obstacleEnablerId, Id obstacleId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
ObstacleEnabler
to an Obstacle.
obstacleEnablerId
- the Id
of the
ObstacleEnabler
obstacleId
- the Id
of the Obstacle
AlreadyExistsException
- obstacleEnablerId
is already applied to obstacleId
NotFoundException
- obstacleEnablerId
or
obstacleId
not foundNullArgumentException
- obstacleEnablerId
or obstacleId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignObstacleEnablerFromObstacle(Id obstacleEnablerId, Id obstacleId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ObstacleEnabler
from an Obstacle.
obstacleEnablerId
- the Id
of the
ObstacleEnabler
obstacleId
- the Id
of the Obstacle
NotFoundException
- obstacleEnablerId
or
obstacleId
not found or
obstacleEnablerId
not applied to obstacleId
NullArgumentException
- obstacleEnablerId
or obstacleId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSequenceObstacleEnablers()
ObstacleEnablers.
A return
of true does not guarantee successful authorization. A return of false
indicates that it is known sequencing operations will result in a
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer sequencing operations to an
unauthorized user. false
if ObstacleEnabler
ordering is not authorized, true
otherwisemandatory
- This method must be implemented. void moveObstacleEnablerAhead(Id obstacleEnablerId, Id obstacleId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
obstacleEnablerId
- the Id
of an
ObstacleEnabler
obstacleId
- the Id
of an Obstacle
referenceId
- the reference obstacle enabler Id
NotFoundException
- obstacleEnablerId,
obstacleId,
or referenceId
not found
or, obstacleEnablerId
or referenceId
not related to obstacleId
NullArgumentException
- obstacleEnablerId,
obstacleId,
or referenceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void moveObstacleEnablerBehind(Id obstacleEnablerId, Id obstacleId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
obstacleEnablerId
- the Id
of an
ObstacleEnabler
obstacleId
- the Id
of an Obstacle
referenceId
- the reference obstacle enabler Id
NotFoundException
- obstacleEnablerId,
obstacleId,
or referenceId
not found
or, obstacleEnablerId
or referenceId
not related to obstacleId
NullArgumentException
- obstacleEnablerId,
obstacleId,
or referenceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void orderObstacleEnablers(Id[] obstacleEnablerIds, Id obstacleId) throws NotFoundException, OperationFailedException, PermissionDeniedException
obstacleEnablerIds
- the Ids
for a set of
ObstacleEnablers
obstacleId
- the Id
of an Obstacle
NotFoundException
- obstacleId
not found
or, an obstacleEnablerId
not related to
obstacleId
NullArgumentException
- obstacleEnabelrIds
or obstacleId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.