OSID Logo
OSID Specifications
checklist package
Version 3.0.0
Release Candidate Preview
Interfaceosid.checklist.TodoHierarchyDesignSession
Implementsosid.OsidSession
Description

This session defines methods for managing a hierarchy of Todo objects. Each node in the hierarchy is a unique Todo.

MethodgetTodoHierarchyId
Description

Gets the hierarchy Id associated with this session.

Returnosid.id.Idthe hierarchy Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetTodoHierarchy
Description

Gets the hierarchy associated with this session.

Returnosid.hierarchy.Hierarchythe hierarchy associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanModifyTodoHierarchy
Description

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 a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer these operations to an unauthorized user.

Returnboolean false if changing this hierarchy is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaddRootTodo
Description

Adds a root todo.

Parametersosid.id.IdtodoIdthe Id of a todo
ErrorsALREADY_EXISTS todoId is already in hierarchy
NOT_FOUND todoId not found
NULL_ARGUMENT todoId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveRootTodo
Description

Removes a root todo.

Parametersosid.id.IdtodoIdthe Id of a todo
ErrorsNOT_FOUND todoId not a root node
NULL_ARGUMENT todoId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaddChildTodo
Description

Adds a child to a todo.

Parametersosid.id.IdtodoIdthe Id of a todo
osid.id.IdchildIdthe Id of the new child
ErrorsALREADY_EXISTS todoId is already a parent of childId
NOT_FOUND todoId or childId not found
NULL_ARGUMENT todoId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildTodo
Description

Removes a child from a todo.

Parametersosid.id.IdtodoIdthe Id of a todo
osid.id.IdchildIdthe Id of the new child
ErrorsNOT_FOUND todoId not a parent of childId
NULL_ARGUMENT todoId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildTodos
Description

Removes all children from a todo.

Parametersosid.id.IdtodoIdthe Id of a todo
ErrorsNOT_FOUND todoId is not in hierarchy
NULL_ARGUMENT todoId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.