public interface EdgeEnablerGraphAssignmentSession extends OsidSession
This session provides methods to re-assign EdgeEnabler
to Graph
mappings. An EdgeEnabler
may appear
in multiple Graph
objects and removing the last reference
to an EdgeEnabler
is the equivalent of deleting it. Each
Graph
may have its own authorizations governing who is
allowed to operate on it.
Adding a reference of an EdgeEnabler
to another
Graph
is not a copy operation (eg: does not change its Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignEdgeEnablerToGraph(Id edgeEnablerId,
Id graphId)
Adds an existing
EdgeEnabler to a Graph. |
boolean |
canAssignEdgeEnablers()
Tests if this user can alter edge enabler/graph mappings.
|
boolean |
canAssignEdgeEnablersToGraph(Id graphId)
Tests if this user can alter edge enabler/graph mappings.
|
IdList |
getAssignableGraphIds(Id graphId)
Gets a list of ontologies including and under the given graph node in
which any edge enabler can be assigned.
|
IdList |
getAssignableGraphIdsForEdgeEnabler(Id graphId,
Id edgeEnablerId)
Gets a list of ontologies including and under the given graph node in
which a specific edge enabler can be assigned.
|
void |
reassignEdgeEnablerToGraph(Id edgeEnablerId,
Id fromGraphId,
Id toGraphId)
Moves an
EdgeEnabler from one Graph to
another. |
void |
unassignEdgeEnablerFromGraph(Id edgeEnablerId,
Id graphId)
Removes an
EdgeEnabler from a Graph. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
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. boolean canAssignEdgeEnablersToGraph(Id graphId)
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer lookup operations to
unauthorized users.graphId
- the Id
of the Graph
false
if mapping is not authorized, true
otherwiseNullArgumentException
- graphId
is
null
mandatory
- This method must be implemented. IdList getAssignableGraphIds(Id graphId) throws OperationFailedException
graphId
- the Id
of the Graph
Ids
NullArgumentException
- graphId
is
null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getAssignableGraphIdsForEdgeEnabler(Id graphId, Id edgeEnablerId) throws OperationFailedException
graphId
- the Id
of the Graph
edgeEnablerId
- the Id
of the EdgeEnabler
Ids
NullArgumentException
- graphId
or
edgeEnablerId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignEdgeEnablerToGraph(Id edgeEnablerId, Id graphId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
EdgeEnabler
to a Graph.
edgeEnablerId
- the Id
of the EdgeEnabler
graphId
- the Id
of the Graph
AlreadyExistsException
- edgeEnablerId
is already assigned to graphId
NotFoundException
- edgeEnablerId
or
graphId
not foundNullArgumentException
- edgeEnablerId
or
graphId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignEdgeEnablerFromGraph(Id edgeEnablerId, Id graphId) throws NotFoundException, OperationFailedException, PermissionDeniedException
EdgeEnabler
from a Graph.
edgeEnablerId
- the Id
of the EdgeEnabler
graphId
- the Id
of the Graph
NotFoundException
- edgeEnablerId
or
graphId
not found or edgeEnablerId
not assigned to graphId
NullArgumentException
- edgeEnablerId
or
graphId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void reassignEdgeEnablerToGraph(Id edgeEnablerId, Id fromGraphId, Id toGraphId) throws NotFoundException, OperationFailedException, PermissionDeniedException
EdgeEnabler
from one Graph
to
another. Mappings to other Graphs
are unaffected.edgeEnablerId
- the Id
of the EdgeEnabler
fromGraphId
- the Id
of the current Graph
toGraphId
- the Id
of the destination
Graph
NotFoundException
- edgeEnablerId, fromGraphId,
or toGraphId
not found or
edgeEnablerId
not mapped to fromGraphId
NullArgumentException
- edgeEnabelrId,
fromGraphId,
or toGraphId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.