public interface AntimatroidHierarchyDesignSession extends OsidSession
This session defines methods for managing a hierarchy of
Antimatroid
objects. Each node in the hierarchy is a unique
Antimatroid.
Modifier and Type | Method and Description |
---|---|
void |
addChildAntimatroid(Id antimatroidId,
Id childId)
Adds a child to an antimatroid.
|
void |
addRootAntimatroid(Id antimatroidId)
Adds a root antimatroid.
|
boolean |
canModifyAntimatroidHierarchy()
Tests if this user can change the hierarchy.
|
Hierarchy |
getAntimatroidHierarchy()
Gets the hierarchy associated with this session.
|
Id |
getAntimatroidHierarchyId()
Gets the hierarchy
Id associated with this session. |
void |
removeChildAntimatroid(Id antimatroidId,
Id childId)
Removes a child from an antimatroid.
|
void |
removeChildAntimatroids(Id antimatroidId)
Removes all children from an antimatroid.
|
void |
removeRootAntimatroid(Id antimatroidId)
Removes a root antimatroid.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getAntimatroidHierarchyId()
Id
associated with this session. Id
associated with this sessionmandatory
- This method must be implemented. Hierarchy getAntimatroidHierarchy() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canModifyAntimatroidHierarchy()
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 addRootAntimatroid(Id antimatroidId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
antimatroidId
- the Id
of an antimatroidAlreadyExistsException
- antimatroidId
is already in hierarchyNotFoundException
- antimatroidId
not
foundNullArgumentException
- antimatroidId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeRootAntimatroid(Id antimatroidId) throws NotFoundException, OperationFailedException, PermissionDeniedException
antimatroidId
- the Id
of an antimatroidNotFoundException
- antimatroidId
is not
a rootNullArgumentException
- antimatroidId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void addChildAntimatroid(Id antimatroidId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
antimatroidId
- the Id
of an antimatroidchildId
- the Id
of the new childAlreadyExistsException
- antimatroidId
is already a parent of childId
NotFoundException
- antimatroidId
or
childId
not foundNullArgumentException
- antimatroidId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildAntimatroid(Id antimatroidId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException
antimatroidId
- the Id
of an antimatroidchildId
- the Id
of the new childNotFoundException
- antimatroidId
is not
parent of childId
NullArgumentException
- antimatroidId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildAntimatroids(Id antimatroidId) throws NotFoundException, OperationFailedException, PermissionDeniedException
antimatroidId
- the Id
of an antimatroidNotFoundException
- antimatroidId
is not
foundNullArgumentException
- antimatroidId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.