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

This session defines methods for retrieving todos.

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
  • isolated checklist view: All todo methods in this session operate, retrieve and pertain to todos defined explicitly in the current checklist. Using an isolated view is useful for managing todos with the TodoAdminSession.
  • federated checklist view: All todo lookup methods in this session operate, retrieve and pertain to all todos defined in this checklist and any other checklists implicitly available in this checklist through checklist inheritence.
  • effective todo view: All todo lookup methods return todos where the current dates falls in between the effective dates inclusive.
  • any effective todo view: Todos of any effective date are returned.
  • sequestered todo viiew: All event methods suppress sequestered todos.
  • unsequestered todo view: All event methods return all todos.

The methods useFederatedChecklistView() and useIsolatedChecklistView() behave as a radio group and one should be selected before invoking any lookup methods.

MethodgetChecklistId
Description

Gets the Checklist Id associated with this session.

Returnosid.id.Idthe Checklist Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetChecklist
Description

Gets the Checklist associated with this session.

Returnosid.checklist.Checklistthe checklist
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupTodos
Description

Tests if this user can examine this checklist. 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 these operations.

Returnboolean false if checklist reading methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeTodoView
Description

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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryTodoView
Description

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

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedChecklistView
Description

Federates the view for methods in this session. A federated view will include todos in checklists which are children of this checklist in the checklist hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedChecklistView
Description

Isolates the view for methods in this session. An isolated view restricts retrievals to this checklist only.

CompliancemandatoryThis method is must be implemented.
MethoduseEffectiveTodoView
Description

Only todos whose effective dates are current are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyEffectiveTodoView
Description

All todos of any effective dates are returned by all methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseSequesteredTodoView
Description

The returns from the lookup methods omit sequestered todos.

CompliancemandatoryThis method is must be implemented.
MethoduseUnsequesteredTodoView
Description

All todos are returned including sequestered todos.

CompliancemandatoryThis method is must be implemented.
MethodgetTodo
Description

Gets the Todo specified by its Id.

In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Todo may have a different Id than requested, such as the case where a duplicate Id was assigned to a Todo and retained for compatibility.

In effective mode, todos are returned that are currently effective. In any effective mode, effective todos and those currently expired are returned.

In sequestered mode, no sequestered todos are returned. In unsequestered mode, all todos are returned.

Parametersosid.id.IdtodoIdthe Id of the Todo to retrieve
Returnosid.checklist.Todothe returned Todo
ErrorsNOT_FOUNDno Todo found with the given Id
NULL_ARGUMENT todoId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetTodosByIds
Description

Gets a TodoList corresponding to the given IdList.

In plenary mode, the returned list contains all of the todos specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible todos may be omitted from the list and may present the elements in any order including returning a unique set.

In effective mode, todos are returned that are currently effective. In any effective mode, effective todos and those currently expired are returned.

In sequestered mode, no sequestered todos are returned. In unsequestered mode, all todos are returned.

Parametersosid.id.IdListtodoIdsthe list of Ids to retrieve
Returnosid.checklist.TodoListthe returned Todo list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT todoIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetTodosByGenusType
Description

Gets a TodoList corresponding to the given todo genus Type which does not include todos of genus types derived from the specified Type.

In plenary mode, the returned list contains all known todos or an error results. Otherwise, the returned list may contain only those todos that are accessible through this session.

In effective mode, todos are returned that are currently effective. In any effective mode, effective todos and those currently expired are returned.

In sequestered mode, no sequestered todos are returned. In unsequestered mode, all todos are returned.

Parametersosid.type.TypetodoGenusTypea todo genus type
Returnosid.checklist.TodoListthe returned Todo list
ErrorsNULL_ARGUMENT todoGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetTodosByParentGenusType
Description

Gets a TodoList corresponding to the given todo genus Type and include any additional todos with genus types derived from the specified Type.

In plenary mode, the returned list contains all known todos or an error results. Otherwise, the returned list may contain only those todos that are accessible through this session.

In effective mode, todos are returned that are currently effective. In any effective mode, effective todos and those currently expired are returned.

In sequestered mode, no sequestered todos are returned. In unsequestered mode, all todos are returned.

Parametersosid.type.TypetodoGenusTypea todo genus type
Returnosid.checklist.TodoListthe returned Todo list
ErrorsNULL_ARGUMENT todoGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetTodosByRecordType
Description

Gets a TodoList containing the given todo record Type.

In plenary mode, the returned list contains all known todos or an error results. Otherwise, the returned list may contain only those todos that are accessible through this session.

In effective mode, todos are returned that are currently effective. In any effective mode, effective todos and those currently expired are returned.

Parametersosid.type.TypetodoRecordTypea todo record type
Returnosid.checklist.TodoListthe returned Todo list
ErrorsNULL_ARGUMENT todoRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetTodosOnDate
Description

Gets a TodoList with starting effective during the entire given date range inclusive but not confined to the date range. This method return sthe same results in either effective status mode.

In plenary mode, the returned list contains all known todos or an error results. Otherwise, the returned list may contain only those todos that are accessible through this session.

In effective mode, todos are returned that are currently effective. In any effective mode, effective todos and those currently expired are returned.

In sequestered mode, no sequestered todos are returned. In unsequestered mode, all todos are returned.

Parametersosid.calendaring.DateTimefromstarting date
osid.calendaring.DateTimetoending date
Returnosid.checklist.TodoListthe returned Todo list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetTodosByPriority
Description

Gets a TodoList at the given priority Type or higher.

In plenary mode, the returned list contains all known todos or an error results. Otherwise, the returned list may contain only those todos that are accessible through this session.

In effective mode, todos are returned that are currently effective. In any effective mode, effective todos and those currently expired are returned.

Parametersosid.type.TypepriorityTypea priority type
Returnosid.checklist.TodoListthe returned Todo list
ErrorsNULL_ARGUMENT priorityType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetTodosByDueDate
Description

Gets a TodoList with a due date within the given date range inclusive .

In plenary mode, the returned list contains all known todos or an error results. Otherwise, the returned list may contain only those todos that are accessible through this session.

In effective mode, todos are returned that are currently effective. In any effective mode, effective todos and those currently expired are returned.

In sequestered mode, no sequestered todos are returned. In unsequestered mode, all todos are returned.

Parametersosid.calendaring.DateTimefromstarting date
osid.calendaring.DateTimetoending date
Returnosid.checklist.TodoListthe returned Todo list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetTodosByDependency
Description

Gets a TodoList of todos dependent upon the given todo.

In plenary mode, the returned list contains all known todos or an error results. Otherwise, the returned list may contain only those todos that are accessible through this session.

In effective mode, todos are returned that are currently effective. In any effective mode, effective todos and those currently expired are returned.

In sequestered mode, no sequestered todos are returned. In unsequestered mode, all todos are returned.

Parametersosid.id.IddependencyTodoIda todo
Returnosid.checklist.TodoListthe returned Todo list
ErrorsNULL_ARGUMENT dependencyTodoId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetTodos
Description

Gets all todos.

In plenary mode, the returned list contains all known todos or an error results. Otherwise, the returned list may contain only those todos that are accessible through this session.

In effective mode, todos are returned that are currently effective. In any effective mode, effective todos and those currently expired are returned.

In sequestered mode, no sequestered todos are returned. In unsequestered mode, all todos are returned.

Returnosid.checklist.TodoLista list of todos
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.