Interface TodoChecklistSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface TodoChecklistSession
extends OsidSession

This session provides methods to retrieve Todo to Checklist mappings. A Todo may appear in multiple Checklists . Each Checklist may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

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

Method Summary

Modifier and Type	Method	Description
boolean	canLookupTodoChecklistMappings()	Tests if this user can perform lookups of todo/checklist mappings.
IdList	getChecklistIdsByTodo(Id todoId)	Gets the list of Checklist Ids mapped to a Todo .
ChecklistList	getChecklistsByTodo(Id todoId)	Gets the list of Checklist objects mapped to a Todo .
IdList	getTodoIdsByChecklist(Id checklistId)	Gets the list of Todo Ids associated with a Checklist .
IdList	getTodoIdsByChecklists(IdList checklistIds)	Gets the list of Todo Ids corresponding to a list of Checklist objects.
TodoList	getTodosByChecklist(Id checklistId)	Gets the list of Todos associated with a Checklist .
TodoList	getTodosByChecklists(IdList checklistIds)	Gets the list of Todos corresponding to a list of Checklists .
void	useComparativeChecklistView()	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryChecklistView()	A complete view of the Todo and Checklist 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

canLookupTodoChecklistMappings

boolean canLookupTodoChecklistMappings()

Tests if this user can perform lookups of todo/checklist mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED . This is intendedas a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeChecklistView

void useComparativeChecklistView()

The returns from the lookup 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.

usePlenaryChecklistView

void usePlenaryChecklistView()

A complete view of the Todo and Checklist 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.

getTodoIdsByChecklist

IdList getTodoIdsByChecklist(Id checklistId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Todo Ids associated with a Checklist .

Parameters:

checklistId - Id of a Checklist .

Returns:

list of related todo Ids

Throws:

NotFoundException - checklistId is not found

NullArgumentException - checklistId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getTodosByChecklist

TodoList getTodosByChecklist(Id checklistId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Todos associated with a Checklist .

Parameters:

checklistId - Id of a Checklist

Returns:

list of related todos

Throws:

NotFoundException - checklistId is not found

NullArgumentException - checklistId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getTodoIdsByChecklists

IdList getTodoIdsByChecklists(IdList checklistIds)
                       throws OperationFailedException,
PermissionDeniedException

Gets the list of Todo Ids corresponding to a list of Checklist objects.

Parameters:

checklistIds - list of checklist Ids

Returns:

list of todo Ids

Throws:

NullArgumentException - checklistIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getTodosByChecklists

TodoList getTodosByChecklists(IdList checklistIds)
                       throws OperationFailedException,
PermissionDeniedException

Gets the list of Todos corresponding to a list of Checklists .

Parameters:

checklistIds - list of checklist Ids

Returns:

list of todos

Throws:

NullArgumentException - checklistIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChecklistIdsByTodo

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

Gets the list of Checklist Ids mapped to a Todo .

Parameters:

todoId - Id of a Todo

Returns:

list of checklist Ids

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.

getChecklistsByTodo

ChecklistList getChecklistsByTodo(Id todoId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Checklist objects mapped to a Todo .

Parameters:

todoId - Id of a Todo

Returns:

list of checklists

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.