Interface | osid.checklist.TodoHierarchySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for traversing a hierarchy of
A user may not be authorized to traverse the entire
hierarchy. Parts of the hierarchy may be made invisible
through omission from the returns of This session defines views that offer differing behaviors when retrieving multiple objects.
| ||
Method | getTodoHierarchyId | ||
Description |
Gets the hierarchy | ||
Return | osid.id.Id | the hierarchy Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getTodoHierarchy | ||
Description |
Gets the hierarchy associated with this session. | ||
Return | osid.hierarchy.Hierarchy | the hierarchy associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canAccessTodoHierarchy | ||
Description |
Tests if this user can perform hierarchy queries. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known all methods in this session will result in a | ||
Return | boolean | false if hierarchy traversal methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeTodoView | ||
Description |
The returns from the todo methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryTodoView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getRootTodoIds | ||
Description |
Gets the root todo | ||
Return | osid.id.IdList | the root todo Ids | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRootTodos | ||
Description |
Gets the root todos in the todo hierarchy. A node with
no parents is an orphan. While all todo | ||
Return | osid.checklist.TodoList | the root todos | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | hasParentTodos | ||
Description |
Tests if the | ||
Parameters | osid.id.Id | todoId | a todo Id |
Return | boolean | true if the todo has parents, false otherwise | |
Errors | NOT_FOUND | todoId is not found | |
NULL_ARGUMENT | todoId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | isParentOfTodo | ||
Description |
Tests if an | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | todoId | the Id of a todo | |
Return | boolean | true if this id is a parent of todoId,
false otherwise | |
Errors | NOT_FOUND | todoId is not found | |
NULL_ARGUMENT | id or todoId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | getParentTodoIds | ||
Description |
Gets the parent | ||
Parameters | osid.id.Id | todoId | a todo Id |
Return | osid.id.IdList | the parent Ids of the todo | |
Errors | NOT_FOUND | todoId is not found | |
NULL_ARGUMENT | todoId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getParentTodos | ||
Description |
Gets the parents of the given todo. | ||
Parameters | osid.id.Id | todoId | the Id to query |
Return | osid.checklist.TodoList | the parents of the todo | |
Errors | NOT_FOUND | todoId not found | |
NULL_ARGUMENT | todoId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | isAncestorOfTodo | ||
Description |
Tests if an | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | todoId | the Id of a todo | |
Return | boolean | true if this id is an ancestor of
todoId, false otherwise | |
Errors | NOT_FOUND | todoId not found | |
NULL_ARGUMENT | id or todoId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | hasChildTodos | ||
Description |
Tests if a todo has any children. | ||
Parameters | osid.id.Id | todoId | a todo Id |
Return | boolean | true if the todoId has children, false
otherwise | |
Errors | NOT_FOUND | todoId not found | |
NULL_ARGUMENT | todoId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | isChildOfTodo | ||
Description |
Tests if a node is a direct child of another. | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | todoId | the Id of a todo | |
Return | boolean | true if the id is a child of todoId,
false otherwise | |
Errors | NOT_FOUND | todoId not found | |
NULL_ARGUMENT | todoId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | getChildTodoIds | ||
Description |
Gets the child | ||
Parameters | osid.id.Id | todoId | a todo Id |
Return | osid.id.IdList | the child Ids of the todo | |
Errors | NOT_FOUND | todoId is not found | |
NULL_ARGUMENT | todoId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getChildTodos | ||
Description |
Gets the children of the given todo. | ||
Parameters | osid.id.Id | todoId | the Id to query |
Return | osid.checklist.TodoList | the children of the todo | |
Errors | NOT_FOUND | todoId not found | |
NULL_ARGUMENT | todoId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | isDescendantOfTodo | ||
Description |
Tests if an | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | todoId | the Id of a todo | |
Return | boolean | true if the id is a descendant of the
todoId, false otherwise | |
Errors | NOT_FOUND | todoId not found | |
NULL_ARGUMENT | todoId or id is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | getTodoNodeIds | ||
Description |
Gets a portion of the hierarchy for the given todo. | ||
Parameters | osid.id.Id | todoId | the Id to query |
cardinal | ancestorLevels | the maximum number of ancestor levels to include. A value of 0 returns no parents in the node. | |
cardinal | descendantLevels | the maximum number of descendant levels to include. A value of 0 returns no children in the node. | |
boolean | includeSiblings | true to include the siblings of the given node, false
to omit the siblings | |
Return | osid.hierarchy.Node | a todo node | |
Errors | NOT_FOUND | todoId not found | |
NULL_ARGUMENT | todoId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getTodoNodes | ||
Description |
Gets a portion of the hierarchy for the given todo. | ||
Parameters | osid.id.Id | todoId | the Id to query |
cardinal | ancestorLevels | the maximum number of ancestor levels to include. A value of 0 returns no parents in the node. | |
cardinal | descendantLevels | the maximum number of descendant levels to include. A value of 0 returns no children in the node. | |
boolean | includeSiblings | true to include the siblings of the given node, false
to omit the siblings | |
Return | osid.checklist.TodoNode | a todo node | |
Errors | NOT_FOUND | todoId not found | |
NULL_ARGUMENT | todoId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |