public interface TodoHierarchyDesignSession extends OsidSession
This session defines methods for managing a hierarchy of Todo
objects. Each node in the hierarchy is a unique Todo.
Modifier and Type | Method and Description |
---|---|
void |
addChildTodo(Id todoId,
Id childId)
Adds a child to a todo.
|
void |
addRootTodo(Id todoId)
Adds a root todo.
|
boolean |
canModifyTodoHierarchy()
Tests if this user can change the hierarchy.
|
Hierarchy |
getTodoHierarchy()
Gets the hierarchy associated with this session.
|
Id |
getTodoHierarchyId()
Gets the hierarchy
Id associated with this session. |
void |
removeChildTodo(Id todoId,
Id childId)
Removes a child from a todo.
|
void |
removeChildTodos(Id todoId)
Removes all children from a todo.
|
void |
removeRootTodo(Id todoId)
Removes a root todo.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getTodoHierarchyId()
Id
associated with this session. Id
associated with this sessionmandatory
- This method must be implemented. Hierarchy getTodoHierarchy() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canModifyTodoHierarchy()
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 addRootTodo(Id todoId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
todoId
- the Id
of a todoAlreadyExistsException
- todoId
is
already in hierarchyNotFoundException
- todoId
not foundNullArgumentException
- todoId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeRootTodo(Id todoId) throws NotFoundException, OperationFailedException, PermissionDeniedException
todoId
- the Id
of a todoNotFoundException
- todoId
not a root
nodeNullArgumentException
- todoId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void addChildTodo(Id todoId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
todoId
- the Id
of a todochildId
- the Id
of the new childAlreadyExistsException
- todoId
is
already a parent of childId
NotFoundException
- todoId
or
childId
not foundNullArgumentException
- todoId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildTodo(Id todoId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException
todoId
- the Id
of a todochildId
- the Id
of the new childNotFoundException
- todoId
not a parent
of childId
NullArgumentException
- todoId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildTodos(Id todoId) throws NotFoundException, OperationFailedException, PermissionDeniedException
todoId
- the Id
of a todoNotFoundException
- todoId is
not in
hierarchyNullArgumentException
- todoId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.