Interface TodoHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface TodoHierarchySession
extends OsidSession

This session defines methods for traversing a hierarchy of Todos . Each todo in the hierarchy is a unique Todo . The hierarchy may be traversed recursively to establish the tree structure through getParentTodos() and getChildTodos() . To relate these Ids to another OSID, getTodoNodes() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any Todo available in the Course OSID is known to this hierarchy but does not appear in the hierarchy traversal until added as a root node or a child of another node.

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 getParentTodos() or getChildTodos() in lieu of a PERMISSION_DENIED error that may disrupt the traversal through authorized pathways.

This session defines views that offer differing behaviors when retrieving multiple objects.

• comparative view: todo elements may be silently omitted or re-ordered
• plenary view: provides a complete set or is an error condition

Method Summary

Modifier and Type	Method	Description
boolean	canAccessTodoHierarchy()	Tests if this user can perform hierarchy queries.
IdList	getChildTodoIds(Id todoId)	Gets the child Ids of the given todo.
TodoList	getChildTodos(Id todoId)	Gets the children of the given todo.
IdList	getParentTodoIds(Id todoId)	Gets the parent Ids of the given todo.
TodoList	getParentTodos(Id todoId)	Gets the parents of the given todo.
IdList	getRootTodoIds()	Gets the root todo Ids in this hierarchy.
TodoList	getRootTodos()	Gets the root todos in the todo hierarchy.
Hierarchy	getTodoHierarchy()	Gets the hierarchy associated with this session.
Id	getTodoHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getTodoNodeIds(Id todoId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given todo.
TodoNode	getTodoNodes(Id todoId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given todo.
boolean	hasChildTodos(Id todoId)	Tests if a todo has any children.
boolean	hasParentTodos(Id todoId)	Tests if the Todo has any parents.
boolean	isAncestorOfTodo(Id id, Id todoId)	Tests if an Id is an ancestor of a todo.
boolean	isChildOfTodo(Id id, Id todoId)	Tests if a node is a direct child of another.
boolean	isDescendantOfTodo(Id id, Id todoId)	Tests if an Id is a descendant of a todo.
boolean	isParentOfTodo(Id id, Id todoId)	Tests if an Id is a direct parent of todo.
void	useComparativeTodoView()	The returns from the todo methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryTodoView()	A complete view of the Todos returns is desired.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getTodoHierarchyId

Id getTodoHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getTodoHierarchy

Hierarchy getTodoHierarchy()
                    throws OperationFailedException,
PermissionDeniedException

Gets the hierarchy associated with this session.

Returns:

the hierarchy associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAccessTodoHierarchy

boolean canAccessTodoHierarchy()

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

Returns:

false if hierarchy traversal methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeTodoView

void useComparativeTodoView()

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.

usePlenaryTodoView

void usePlenaryTodoView()

A complete view of the Todos returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

getRootTodoIds

IdList getRootTodoIds()
               throws OperationFailedException,
PermissionDeniedException

Gets the root todo Ids in this hierarchy.

Returns:

the root todo Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootTodos

TodoList getRootTodos()
               throws OperationFailedException,
PermissionDeniedException

Gets the root todos in the todo hierarchy. A node with no parents is an orphan. While all todo Ids are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root node or child of another node.

Returns:

the root todos

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentTodos

boolean hasParentTodos(Id todoId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the Todo has any parents.

Parameters:

todoId - a todo Id

Returns:

true if the todo has parents, false otherwise

Throws:

NotFoundException - todoId is not found

NullArgumentException - todoId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isParentOfTodo

boolean isParentOfTodo(Id id,
 Id todoId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a direct parent of todo.

Parameters:

id - an Id

todoId - the Id of a todo

Returns:

true if this id is a parent of todoId , false otherwise

Throws:

NotFoundException - todoId is not found

NullArgumentException - id or todoId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

getParentTodoIds

IdList getParentTodoIds(Id todoId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given todo.

Parameters:

todoId - a todo Id

Returns:

the parent Ids of the todo

Throws:

NotFoundException - todoId is not found

NullArgumentException - todoId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParentTodos

TodoList getParentTodos(Id todoId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parents of the given todo.

Parameters:

todoId - the Id to query

Returns:

the parents of the todo

Throws:

NotFoundException - todoId not found

NullArgumentException - todoId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfTodo

boolean isAncestorOfTodo(Id id,
 Id todoId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of a todo.

Parameters:

id - an Id

todoId - the Id of a todo

Returns:

true if this id is an ancestor of todoId , false otherwise

Throws:

NotFoundException - todoId not found

NullArgumentException - id or todoId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

hasChildTodos

boolean hasChildTodos(Id todoId)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a todo has any children.

Parameters:

todoId - a todo Id

Returns:

true if the todoId has children, false otherwise

Throws:

NotFoundException - todoId not found

NullArgumentException - todoId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfTodo

boolean isChildOfTodo(Id id,
 Id todoId)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a node is a direct child of another.

Parameters:

id - an Id

todoId - the Id of a todo

Returns:

true if the id is a child of todoId , false otherwise

Throws:

NotFoundException - todoId not found

NullArgumentException - todoId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

getChildTodoIds

IdList getChildTodoIds(Id todoId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given todo.

Parameters:

todoId - a todo Id

Returns:

the child Ids of the todo

Throws:

NotFoundException - todoId is not found

NullArgumentException - todoId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildTodos

TodoList getChildTodos(Id todoId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the children of the given todo.

Parameters:

todoId - the Id to query

Returns:

the children of the todo

Throws:

NotFoundException - todoId not found

NullArgumentException - todoId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfTodo

boolean isDescendantOfTodo(Id id,
 Id todoId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of a todo.

Parameters:

id - an Id

todoId - the Id of a todo

Returns:

true if the id is a descendant of the todoId , false otherwise

Throws:

NotFoundException - todoId not found

NullArgumentException - todoId or id is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} is not found return {@code false} .

getTodoNodeIds

Node getTodoNodeIds(Id todoId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given todo.

Parameters:

todoId - the Id to query

ancestorLevels - the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.

descendantLevels - the maximum number of descendant levels to include. A value of 0 returns no children in the node.

includeSiblings - true to include the siblings of the given node, false to omit the siblings

Returns:

a todo node

Throws:

NotFoundException - todoId not found

NullArgumentException - todoId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getTodoNodes

TodoNode getTodoNodes(Id todoId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given todo.

Parameters:

todoId - the Id to query

ancestorLevels - the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.

descendantLevels - the maximum number of descendant levels to include. A value of 0 returns no children in the node.

includeSiblings - true to include the siblings of the given node, false to omit the siblings

Returns:

a todo node

Throws:

NotFoundException - todoId not found

NullArgumentException - todoId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.