public interface SystemHierarchyDesignSession extends OsidSession
This session defines methods for managing a hierarchy of System
objects. Each node in the hierarchy is a unique System.
Modifier and Type | Method and Description |
---|---|
void |
addChildSystem(Id systemId,
Id childId)
Adds a child to a system.
|
void |
addRootSystem(Id systemId)
Adds a root system.
|
boolean |
canModifySystemHierarchy()
Tests if this user can change the hierarchy.
|
Hierarchy |
getSystemHierarchy()
Gets the hierarchy associated with this session.
|
Id |
getSystemHierarchyId()
Gets the hierarchy
Id associated with this session. |
void |
removeChildSystem(Id systemId,
Id childId)
Removes a child from a system.
|
void |
removeChildSystems(Id systemId)
Removes all children from a system.
|
void |
removeRootSystem(Id systemId)
Removes a root system.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getSystemHierarchyId()
Id
associated with this session. Id
associated with this sessionmandatory
- This method must be implemented. Hierarchy getSystemHierarchy() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canModifySystemHierarchy()
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 addRootSystem(Id systemId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
systemId
- the Id
of a systemAlreadyExistsException
- systemId
is
already in hierarchyNotFoundException
- systemId
not foundNullArgumentException
- systemId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeRootSystem(Id systemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
systemId
- the Id
of a systemNotFoundException
- systemId
is not a
rootNullArgumentException
- systemId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void addChildSystem(Id systemId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
systemId
- the Id
of a systemchildId
- the Id
of the new childAlreadyExistsException
- systemId
is
already a parent of childId
NotFoundException
- systemId
or
childId
not foundNullArgumentException
- systemId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildSystem(Id systemId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException
systemId
- the Id
of a systemchildId
- the Id
of the new childNotFoundException
- systemId
is not
parent of childId
NullArgumentException
- systemId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildSystems(Id systemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
systemId
- the Id
of a systemNotFoundException
- systemId
is not
foundNullArgumentException
- systemId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.