public interface OublietteHierarchyDesignSession extends OsidSession
This session defines methods for managing a hierarchy of
Oubliette
objects. Each node in the hierarchy is a unique
Oubliette.
Modifier and Type | Method and Description |
---|---|
void |
addChildOubliette(Id oublietteId,
Id childId)
Adds a child to an oubliette.
|
void |
addRootOubliette(Id oublietteId)
Adds a root oubliette.
|
boolean |
canModifyOublietteHierarchy()
Tests if this user can change the hierarchy.
|
Hierarchy |
getOublietteHierarchy()
Gets the hierarchy associated with this session.
|
Id |
getOublietteHierarchyId()
Gets the hierarchy
Id associated with this session. |
void |
removeChildOubliette(Id oublietteId,
Id childId)
Removes a child from an oubliette.
|
void |
removeChildOubliettes(Id oublietteId)
Removes all children from an oubliette.
|
void |
removeRootOubliette(Id oublietteId)
Removes a root oubliette.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getOublietteHierarchyId()
Id
associated with this session. Id
associated with this sessionmandatory
- This method must be implemented. Hierarchy getOublietteHierarchy() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canModifyOublietteHierarchy()
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 addRootOubliette(Id oublietteId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
oublietteId
- the Id
of an oublietteAlreadyExistsException
- oublietteId
is
already in hierarchyNotFoundException
- oublietteId
not
foundNullArgumentException
- oublietteId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeRootOubliette(Id oublietteId) throws NotFoundException, OperationFailedException, PermissionDeniedException
oublietteId
- the Id
of an oublietteNotFoundException
- oublietteId
is not a
rootNullArgumentException
- oublietteId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void addChildOubliette(Id oublietteId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
oublietteId
- the Id
of an oubliettechildId
- the Id
of the new childAlreadyExistsException
- oublietteId
is
already a parent of childId
NotFoundException
- oublietteId
or
childId
not foundNullArgumentException
- oublietteId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildOubliette(Id oublietteId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException
oublietteId
- the Id
of an oubliettechildId
- the Id
of the new childNotFoundException
- oublietteId
is not
parent of childId
NullArgumentException
- oublietteId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildOubliettes(Id oublietteId) throws NotFoundException, OperationFailedException, PermissionDeniedException
oublietteId
- the Id
of an oublietteNotFoundException
- oublietteId
is not
foundNullArgumentException
- oublietteId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.