public interface EdgeEnablerGraphSession extends OsidSession
This session provides methods to retrieve EdgeEnabler
to
Graph
mappings. An EdgeEnabler
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 |
canLookupEdgeEnablerGraphMappings()
Tests if this user can perform lookups of edge enabler/graph mappings.
|
IdList |
getEdgeEnablerIdsByGraph(Id graphId)
Gets the list of
EdgeEnablerIds associated with a
Graph. |
IdList |
getEdgeEnablerIdsByOntologies(IdList graphIds)
Gets the list of
EdgeEnabler Ids corresponding to a
list of Ontologies. |
EdgeEnablerList |
getEdgeEnablersByGraph(Id graphId)
Gets the list of edge enablers associated with a
Graph. |
EdgeEnablerList |
getEdgeEnablersByOntologies(IdList graphIds)
Gets the list of edge enablers corresponding to a list of
Ontologies. |
IdList |
getGraphIdsByEdgeEnabler(Id edgeEnablerId)
Gets the
Graph Ids mapped to an
EdgeEnabler. |
GraphList |
getOntologiesByEdgeEnabler(Id edgeEnablerId)
Gets the
Ontologies mapped to an EdgeEnabler. |
void |
useComparativeEdgeEnablerGraphView()
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 |
usePlenaryEdgeEnablerGraphView()
A complete view of the
EdgeEnabler and Graph
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupEdgeEnablerGraphMappings()
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 useComparativeEdgeEnablerGraphView()
mandatory
- This method is must be implemented. void usePlenaryEdgeEnablerGraphView()
EdgeEnabler
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 getEdgeEnablerIdsByGraph(Id graphId) throws NotFoundException, OperationFailedException, PermissionDeniedException
EdgeEnablerIds
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. EdgeEnablerList getEdgeEnablersByGraph(Id graphId) throws NotFoundException, OperationFailedException, PermissionDeniedException
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 getEdgeEnablerIdsByOntologies(IdList graphIds) throws OperationFailedException, PermissionDeniedException
EdgeEnabler Ids
corresponding to a
list of Ontologies.
graphIds
- list of graph Ids
Ids
NullArgumentException
- graphIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. EdgeEnablerList getEdgeEnablersByOntologies(IdList graphIds) throws OperationFailedException, PermissionDeniedException
Ontologies.
graphIds
- list of graph Ids
NullArgumentException
- graphIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getGraphIdsByEdgeEnabler(Id edgeEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Graph
Ids
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. GraphList getOntologiesByEdgeEnabler(Id edgeEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Ontologies
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.