public interface FoundryHierarchyDesignSession extends OsidSession
This session defines methods for managing a hierarchy of Foundry
objects. Each node in the hierarchy is a unique Foundry.
Modifier and Type | Method and Description |
---|---|
void |
addChildFoundry(Id foundryId,
Id childId)
Adds a child to a foundry.
|
void |
addRootFoundry(Id foundryId)
Adds a root foundry.
|
boolean |
canModifyFoundryHierarchy()
Tests if this user can change the hierarchy.
|
Hierarchy |
getFoundryHierarchy()
Gets the hierarchy associated with this session.
|
Id |
getFoundryHierarchyId()
Gets the hierarchy
Id associated with this session. |
void |
removeChildFoundries(Id foundryId)
Removes all children from a foundry.
|
void |
removeChildFoundry(Id foundryId,
Id childId)
Removes a child from a foundry.
|
void |
removeRootFoundry(Id foundryId)
Removes a root foundry.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getFoundryHierarchyId()
Id
associated with this session. Id
associated with this sessionmandatory
- This method must be implemented. Hierarchy getFoundryHierarchy() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canModifyFoundryHierarchy()
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 addRootFoundry(Id foundryId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
foundryId
- the Id
of a foundryAlreadyExistsException
- foundryId
is
already in hierarchyNotFoundException
- foundryId
not foundNullArgumentException
- foundryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeRootFoundry(Id foundryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
foundryId
- the Id
of a foundryNotFoundException
- foundryId
is not a
rootNullArgumentException
- foundryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void addChildFoundry(Id foundryId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
foundryId
- the Id
of a foundrychildId
- the Id
of the new childAlreadyExistsException
- foundryId
is
already a parent of childId
NotFoundException
- foundryId
or
childId
not foundNullArgumentException
- foundryId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildFoundry(Id foundryId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException
foundryId
- the Id
of a foundrychildId
- the Id
of the new childNotFoundException
- foundryId
is not
parent of childId
NullArgumentException
- foundryId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildFoundries(Id foundryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
foundryId
- the Id
of a foundryNotFoundException
- foundryId
is not
foundNullArgumentException
- foundryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.