public interface ProcessHierarchyDesignSession extends OsidSession
This session defines methods for managing a hierarchy of Process
objects. Each node in the hierarchy is a unique Process.
Modifier and Type | Method and Description |
---|---|
void |
addChildProcess(Id processId,
Id childId)
Adds a child to a process.
|
void |
addRootProcess(Id processId)
Adds a root process.
|
boolean |
canModifyProcessHierarchy()
Tests if this user can change the hierarchy.
|
Hierarchy |
getProcessHierarchy()
Gets the hierarchy associated with this session.
|
Id |
getProcessHierarchyId()
Gets the hierarchy
Id associated with this session. |
void |
removeChildProcess(Id processId,
Id childId)
Removes a child from a process.
|
void |
removeChildProcesses(Id processId)
Removes all children from a process.
|
void |
removeRootProcess(Id processId)
Removes a root process.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getProcessHierarchyId()
Id
associated with this session. Id
associated with this sessionmandatory
- This method must be implemented. Hierarchy getProcessHierarchy() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canModifyProcessHierarchy()
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 addRootProcess(Id processId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
processId
- the Id
of a processAlreadyExistsException
- processId
is
already in hierarchyNotFoundException
- processId
not foundNullArgumentException
- processId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeRootProcess(Id processId) throws NotFoundException, OperationFailedException, PermissionDeniedException
processId
- the Id
of a processNotFoundException
- processId
is not a
rootNullArgumentException
- processId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void addChildProcess(Id processId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
processId
- the Id
of a processchildId
- the Id
of the new childAlreadyExistsException
- processId
is
already a parent of childId
NotFoundException
- processId
or
childId
not foundNullArgumentException
- processId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildProcess(Id processId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException
processId
- the Id
of a processchildId
- the Id
of the new childNotFoundException
- processId
not a
parent of childId
NullArgumentException
- processId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildProcesses(Id processId) throws NotFoundException, OperationFailedException, PermissionDeniedException
processId
- the Id
of a processNotFoundException
- processId
not in
hierarchyNullArgumentException
- processId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.