public interface EdgeEnablerRuleLookupSession extends OsidSession
This session provides methods to retrieve EdgeEnabler
to
Edge
mappings. An Edge
with multiple
EdgeEnablers
means any positive rule evaluation across the
enablers result in an effective Edge.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupEdgeEnablerRules()
Tests if this user can perform lookups of edge enabler/edge mappings.
|
IdList |
getEdgeEnablerIdsForEdge(Id edgeId)
Gets the
EdgeEnabler Id associated with an Edge. |
EdgeEnablerList |
getEdgeEnablersForEdge(Id edgeId)
Gets the
EdgeEnabler associated with an Edge. |
IdList |
getEdgeIdsByEdgeEnabler(Id edgeEnablerId)
Gets the
Edge Ids mapped to an
EdgeEnabler. |
EdgeList |
getEdgesByEdgeEnabler(Id edgeEnablerId)
Gets the
Edges mapped to an EdgeEnabler. |
Graph |
getGraph()
Gets the
Graph associated with this session. |
Id |
getGraphId()
Gets the
Graph Id associated with this
session. |
void |
useComparativeEdgeEnablerRuleView()
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 |
useFederatedGraphView()
Federates the view for methods in this session.
|
void |
useIsolatedGraphView()
Isolates the view for methods in this session.
|
void |
usePlenaryEdgeEnablerRuleView()
A complete view of the
EdgeEnabler and Edge
returns is desired. |
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 canLookupEdgeEnablerRules()
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 useComparativeEdgeEnablerRuleView()
mandatory
- This method is must be implemented. void usePlenaryEdgeEnablerRuleView()
EdgeEnabler
and Edge
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 useFederatedGraphView()
mandatory
- This method is must be implemented. void useIsolatedGraphView()
mandatory
- This method is must be implemented. IdList getEdgeEnablerIdsForEdge(Id edgeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
EdgeEnabler Id
associated with an Edge.
edgeId
- Id
of the Edge
Ids
NotFoundException
- edgeId
is not foundNullArgumentException
- edgeId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. EdgeEnablerList getEdgeEnablersForEdge(Id edgeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
EdgeEnabler
associated with an Edge.
edgeId
- Id
of the Edge
NotFoundException
- edgeId
is not foundNullArgumentException
- edgeId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getEdgeIdsByEdgeEnabler(Id edgeEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Edge
Ids
mapped to an
EdgeEnabler.
edgeEnablerId
- Id
of an EdgeEnabler
Ids
NotFoundException
- edgeEnablerId
is not
foundNullArgumentException
- edgeEnablerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. EdgeList getEdgesByEdgeEnabler(Id edgeEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Edges
mapped to an EdgeEnabler.
edgeEnablerId
- Id
of an EdgeEnabler
NotFoundException
- edgeEnablerId
is not
foundNullArgumentException
- edgeEnablerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.