public interface EdgeGraphSession extends OsidSession
This session provides methods to retrieve Edge
to
Graph
mappings. An Edge
may appear in multiple
Graph
objects. Each graph may have its own authorizations
governing who is allowed to look at it.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupEdgeGraphMappings()
Tests if this user can perform lookups of edge/graph mappings.
|
IdList |
getEdgeIdsByGraph(Id graphId)
Gets the list of
Edge Ids associated with a
Graph. |
IdList |
getEdgeIdsByGraphs(IdList graphIds)
Gets the list of
Edge Ids corresponding to a list of
Graphs. |
EdgeList |
getEdgesByGraph(Id graphId)
Gets the list of
Edges associated with a Graph. |
EdgeList |
getEdgesByGraphs(IdList graphIds)
Gets the list of
Edge corresponding to a list of
Graphs. |
IdList |
getGraphIdsByEdge(Id edgeId)
Gets the
Graph Ids mapped to an
Edge. |
GraphList |
getGraphsByEdge(Id edgeId)
Gets the
Graphs mapped to an Edge. |
void |
useComparativeEdgeGraphView()
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 |
usePlenaryEdgeGraphView()
A complete view of the
Edge and Graph
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupEdgeGraphMappings()
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 useComparativeEdgeGraphView()
mandatory
- This method is must be implemented. void usePlenaryEdgeGraphView()
Edge
and Graph
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. IdList getEdgeIdsByGraph(Id graphId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Edge Ids
associated with a
Graph.
graphId
- Id
of the Graph
Ids
NotFoundException
- graphId
is not foundNullArgumentException
- graphId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. EdgeList getEdgesByGraph(Id graphId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Edges
associated with a Graph.
graphId
- Id
of the Graph
NotFoundException
- graphId
is not foundNullArgumentException
- graphId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getEdgeIdsByGraphs(IdList graphIds) throws OperationFailedException, PermissionDeniedException
Edge Ids
corresponding to a list of
Graphs.
graphIds
- list of graph Ids
Ids
NullArgumentException
- graphIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. EdgeList getEdgesByGraphs(IdList graphIds) throws OperationFailedException, PermissionDeniedException
Edge
corresponding to a list of
Graphs.
graphIds
- list of graph Ids
NullArgumentException
- graphIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getGraphIdsByEdge(Id edgeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Graph
Ids
mapped to an
Edge.
edgeId
- Id
of an Edge
NotFoundException
- edgeId
is not foundNullArgumentException
- edgeId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. GraphList getGraphsByEdge(Id edgeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Graphs
mapped to an Edge.
edgeId
- Id
of an Edge
NotFoundException
- edgeId
is not foundNullArgumentException
- edgeId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.