public interface EdgeEnablerRuleApplicationSession extends OsidSession
This session provides methods to apply EdgeEnablers
to
Edges.
An Edge
with multiple
EdgeEnablers
means any positive rule evaluation across the
enablers result in an effective Edge.
Modifier and Type | Method and Description |
---|---|
void |
assignEdgeEnablerToEdge(Id edgeEnablerId,
Id edgeId)
Adds an existing
EdgeEnabler to an Edge. |
boolean |
canAssignEdgeEnablers()
Tests if this user can alter edge enabler/edge mappings.
|
boolean |
canSequenceEdgeEnablers()
Tests if this user can order
EdgeEnablers. |
Graph |
getGraph()
Gets the
Graph associated with this session. |
Id |
getGraphId()
Gets the
Graph Id associated with this
session. |
void |
moveEdgeEnablerAhead(Id edgeEnablerId,
Id edgeId,
Id referenceId)
Reorders edge enablers for an edge by moving the specified edge
enabler in front of a reference edge enabler.
|
void |
moveEdgeEnablerBehind(Id edgeEnablerId,
Id edgeId,
Id referenceId)
Reorders edge enablers for an edge by moving the specified edge
enabler behind a reference edge enabler.
|
void |
orderEdgeEnablers(Id[] edgeEnablerIds,
Id edgeId)
Reorders a set of edge enablers for an edge.
|
void |
unassignEdgeEnablerFromEdge(Id edgeEnablerId,
Id edgeId)
Removes an
EdgeEnabler from an Edge. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getGraphId()
Graph
Id
associated with this
session. Graph Id
associated with this sessionmandatory
- This method must be implemented. Graph getGraph() throws OperationFailedException, PermissionDeniedException
Graph
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canAssignEdgeEnablers()
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 assignEdgeEnablerToEdge(Id edgeEnablerId, Id edgeId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
EdgeEnabler
to an Edge.
edgeEnablerId
- the Id
of the EdgeEnabler
edgeId
- the Id
of the Edge
AlreadyExistsException
- edgeEnablerId
is already applied to edgeId
NotFoundException
- edgeEnablerId
or
edgeId
not foundNullArgumentException
- edgeEnablerId
or
edgeId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignEdgeEnablerFromEdge(Id edgeEnablerId, Id edgeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
EdgeEnabler
from an Edge.
edgeEnablerId
- the Id
of the EdgeEnabler
edgeId
- the Id
of the Edge
NotFoundException
- edgeEnablerId
or
edgeId
not found or edgeEnablerId
is not applied to edgeId
NullArgumentException
- edgeEnablerId
or
edgeId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSequenceEdgeEnablers()
EdgeEnablers.
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 EdgeEnabler
ordering is
not authorized, true
otherwisemandatory
- This method must be implemented. void moveEdgeEnablerAhead(Id edgeEnablerId, Id edgeId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
edgeEnablerId
- the Id
of an EdgeEnabler
edgeId
- the Id
of an Edge
referenceId
- the reference edge enabler Id
NotFoundException
- edgeEnablerId, edgeId,
or referenceId
not found or,
edgeEnablerId
or referenceId
not
related to edgeId
NullArgumentException
- edgeEnablerId, edgeId,
or referenceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void moveEdgeEnablerBehind(Id edgeEnablerId, Id edgeId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
edgeEnablerId
- the Id
of an EdgeEnabler
edgeId
- the Id
of an Edge
referenceId
- the reference edge enabler Id
NotFoundException
- edgeEnablerId, edgeId,
or referenceId
not found or,
edgeEnablerId
or referenceId
not
related to edgeId
NullArgumentException
- edgeEnablerId, edgeId,
or referenceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void orderEdgeEnablers(Id[] edgeEnablerIds, Id edgeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
edgeEnablerIds
- the Ids
for a set of
EdgeEnablers
edgeId
- the Id
of an Edge
NotFoundException
- edgeId
not found or,
an edgeEnablerId
not related to edgeId
NullArgumentException
- edgeEnablerIds
or edgeId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.