Interface TodoHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface TodoHierarchyDesignSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	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.

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.

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

Returns:

false if changing this hierarchy is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

addRootTodo

void addRootTodo(Id todoId)
          throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root todo.

Parameters:

todoId - the Id of a todo

Throws:

AlreadyExistsException - todoId is already in hierarchy

NotFoundException - todoId not found

NullArgumentException - todoId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootTodo

void removeRootTodo(Id todoId)
             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root todo.

Parameters:

todoId - the Id of a todo

Throws:

NotFoundException - todoId not a root node

NullArgumentException - todoId is null

OperationFailedException - unable to complete request

PermissionDeniedException - 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 - the Id of a todo

childId - the Id of the new child

Throws:

AlreadyExistsException - todoId is already a parent of childId

NotFoundException - todoId or childId not found

NullArgumentException - todoId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - 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 - the Id of a todo

childId - the Id of the new child

Throws:

NotFoundException - todoId not a parent of childId

NullArgumentException - todoId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - 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 - the Id of a todo

Throws:

NotFoundException - todoId is not in hierarchy

NullArgumentException - todoId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.