public interface InquestHierarchyDesignSession extends OsidSession
This session defines methods for managing a hierarchy of Inquest
objects. Each node in the hierarchy is a unique Inquest.
Modifier and Type | Method and Description |
---|---|
void |
addChildInquest(Id inquestId,
Id childId)
Adds a child to an inquest.
|
void |
addRootInquest(Id inquestId)
Adds a root inquest.
|
boolean |
canModifyInquestHierarchy()
Tests if this user can change the hierarchy.
|
Hierarchy |
getInquestHierarchy()
Gets the hierarchy associated with this session.
|
Id |
getInquestHierarchyId()
Gets the hierarchy
Id associated with this session. |
void |
removeChildInquest(Id inquestId,
Id childId)
Removes a child from an inquest.
|
void |
removeChildInquests(Id inquestId)
Removes all children from an inquest.
|
void |
removeRootInquest(Id inquestId)
Removes a root inquest.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getInquestHierarchyId()
Id
associated with this session. Id
associated with this sessionmandatory
- This method must be implemented. Hierarchy getInquestHierarchy() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canModifyInquestHierarchy()
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 addRootInquest(Id inquestId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
inquestId
- the Id
of an inquestAlreadyExistsException
- inquestId
is
already in hierarchyNotFoundException
- inquestId
not foundNullArgumentException
- inquestId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeRootInquest(Id inquestId) throws NotFoundException, OperationFailedException, PermissionDeniedException
inquestId
- the Id
of an inquestNotFoundException
- inquestId
is not a
rootNullArgumentException
- inquestId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void addChildInquest(Id inquestId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
inquestId
- the Id
of an inquestchildId
- the Id
of the new childAlreadyExistsException
- inquestId
is
already a parent of childId
NotFoundException
- inquestId
or
childId
not foundNullArgumentException
- inquestId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildInquest(Id inquestId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException
inquestId
- the Id
of an inquestchildId
- the Id
of the new childNotFoundException
- inquestId
is not
parent of childId
NullArgumentException
- inquestId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildInquests(Id inquestId) throws NotFoundException, OperationFailedException, PermissionDeniedException
inquestId
- the Id
of an inquestNotFoundException
- inquestId
is not
foundNullArgumentException
- inquestId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.