Interface TodoHierarchyDesignSession
- All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
This session defines methods for managing a hierarchy of Todos
. Each node in the hierarchy is a unique Todo .
-
Method Summary
Modifier and TypeMethodDescriptionvoidaddChildTodo(Id todoId, Id childId) Adds a child to a todo.voidaddRootTodo(Id todoId) Adds a root todo.booleanTests if this user can change the hierarchy.Gets the hierarchy associated with this session.Gets the hierarchyIdassociated with this session.voidremoveChildTodo(Id todoId, Id childId) Removes a child from a todo.voidremoveChildTodos(Id todoId) Removes all children from a todo.voidremoveRootTodo(Id todoId) Removes a root todo.Methods inherited from interface OsidSession
closeMethods inherited from interface OsidSession
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactionsModifier and TypeMethodDescriptionGets the agent authenticated to this session.Gets theIdof the agent authenticated to this session.Gets the rate of the service clock.getDate()Gets the service date which may be the current date or the effective date in which this session exists.Gets the effective agent in use by this session.Gets theIdof the effective agent in use by this session.Gets theDisplayTextformatTypepreference in effect for this session.Gets the locale indicating the localization preferences in effect for this session.booleanTests if an agent is authenticated to this session.Starts a new transaction for this sesson.booleanTests for the availability of transactions.
-
Method Details
-
getTodoHierarchyId
Id getTodoHierarchyId()Gets the hierarchyIdassociated with this session.- Returns:
- the hierarchy
Idassociated with this session - Compliance:
mandatory- This method must be implemented.
-
getTodoHierarchy
Gets the hierarchy associated with this session.- Returns:
- the hierarchy associated with this session
- Throws:
OperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
canModifyTodoHierarchy
boolean canModifyTodoHierarchy()Tests if this user can change the hierarchy. A return of true does not guarantee successful authorization. A return of false indicates that it is known performing any update will result in aPERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer these operations to an unauthorized user.- Returns:
falseif changing this hierarchy is not authorized,trueotherwise- Compliance:
mandatory- This method must be implemented.
-
addRootTodo
void addRootTodo(Id todoId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException Adds a root todo.- Parameters:
todoId- theIdof a todo- Throws:
AlreadyExistsException-todoIdis already in hierarchyNotFoundException-todoIdnot foundNullArgumentException-todoIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
removeRootTodo
void removeRootTodo(Id todoId) throws NotFoundException, OperationFailedException, PermissionDeniedException Removes a root todo.- Parameters:
todoId- theIdof a todo- Throws:
NotFoundException-todoIdnot a root nodeNullArgumentException-todoIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
addChildTodo
void addChildTodo(Id todoId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException Adds a child to a todo.- Parameters:
todoId- theIdof a todochildId- theIdof the new child- Throws:
AlreadyExistsException-todoIdis already a parent ofchildIdNotFoundException-todoIdorchildIdnot foundNullArgumentException-todoIdorchildIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
removeChildTodo
void removeChildTodo(Id todoId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException Removes a child from a todo.- Parameters:
todoId- theIdof a todochildId- theIdof the new child- Throws:
NotFoundException-todoIdnot a parent ofchildIdNullArgumentException-todoIdorchildIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
removeChildTodos
void removeChildTodos(Id todoId) throws NotFoundException, OperationFailedException, PermissionDeniedException Removes all children from a todo.- Parameters:
todoId- theIdof a todo- Throws:
NotFoundException-todoId isnot in hierarchyNullArgumentException-todoIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-