public interface GraphHierarchyDesignSession extends OsidSession
This session defines methods for managing a hierarchy of Graph
objects. Each node in the hierarchy is a unique Graph.
Modifier and Type | Method and Description |
---|---|
void |
addChildGraph(Id graphId,
Id childId)
Adds a child to a graph.
|
void |
addRootGraph(Id graphId)
Adds a root graph.
|
boolean |
canModifyGraphHierarchy()
Tests if this user can change the hierarchy.
|
Hierarchy |
getGraphHierarchy()
Gets the hierarchy associated with this session.
|
Id |
getGraphHierarchyId()
Gets the hierarchy
Id associated with this session. |
void |
removeChildGraph(Id graphId,
Id childId)
Removes a child from a graph.
|
void |
removeChildGraphs(Id graphId)
Removes all children from a graph.
|
void |
removeRootGraph(Id graphId)
Removes a root graph.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getGraphHierarchyId()
Id
associated with this session. Id
associated with this sessionmandatory
- This method must be implemented. Hierarchy getGraphHierarchy() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canModifyGraphHierarchy()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer these operations to an
unauthorized user. false
if changing this hierarchy is not
authorized, true
otherwisemandatory
- This method must be implemented. void addRootGraph(Id graphId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
graphId
- the Id
of a graphAlreadyExistsException
- graphId
is
already in hierarchyNotFoundException
- graphId
not foundNullArgumentException
- graphId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeRootGraph(Id graphId) throws NotFoundException, OperationFailedException, PermissionDeniedException
graphId
- the Id
of a graphNotFoundException
- graphId
not a rootNullArgumentException
- graphId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void addChildGraph(Id graphId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
graphId
- the Id
of a graphchildId
- the Id
of the new childAlreadyExistsException
- graphId
is
already a parent of childId
NotFoundException
- graphId
or
childId
not foundNullArgumentException
- graphId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildGraph(Id graphId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException
graphId
- the Id
of a graphchildId
- the Id
of the new childNotFoundException
- graphId
not a parent
of childId
NullArgumentException
- graphId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildGraphs(Id graphId) throws NotFoundException, OperationFailedException, PermissionDeniedException
graphId
- the Id
of a graphNotFoundException
- graphId
not in
hierarchyNullArgumentException
- graphId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.