OSID - osid.checklist.TodoLookupSession Service Interface Definition

Interface	osid.checklist.TodoLookupSession
Implements	`osid.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.
Method	getChecklistId
Description	Gets the `Checklist` `Id` associated with this session.
Return	`osid.id.Id`		the `Checklist Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getChecklist
Description	Gets the `Checklist` associated with this session.
Return	`osid.checklist.Checklist`		the checklist
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupTodos
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.
Return	`boolean`		`false` if checklist reading methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeTodoView
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.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryTodoView
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.
Compliance	`mandatory`		This method is must be implemented.
Method	useFederatedChecklistView
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.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedChecklistView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this checklist only.
Compliance	`mandatory`		This method is must be implemented.
Method	useEffectiveTodoView
Description	Only todos whose effective dates are current are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectiveTodoView
Description	All todos of any effective dates are returned by all methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useSequesteredTodoView
Description	The returns from the lookup methods omit sequestered todos.
Compliance	`mandatory`		This method is must be implemented.
Method	useUnsequesteredTodoView
Description	All todos are returned including sequestered todos.
Compliance	`mandatory`		This method is must be implemented.
Method	getTodo
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.
Parameters	`osid.id.Id`	`todoId`	the `Id` of the `Todo` to retrieve
Return	`osid.checklist.Todo`		the returned `Todo`
Errors	NOT_FOUND		no `Todo` found with the given `Id`
	NULL_ARGUMENT		`todoId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getTodosByIds
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.
Parameters	`osid.id.IdList`	`todoIds`	the list of `Ids` to retrieve
Return	`osid.checklist.TodoList`		the returned `Todo list`
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`todoIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getTodosByGenusType
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.
Parameters	`osid.type.Type`	`todoGenusType`	a todo genus type
Return	`osid.checklist.TodoList`		the returned `Todo` list
Errors	NULL_ARGUMENT		`todoGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getTodosByParentGenusType
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.
Parameters	`osid.type.Type`	`todoGenusType`	a todo genus type
Return	`osid.checklist.TodoList`		the returned `Todo` list
Errors	NULL_ARGUMENT		`todoGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getTodosByRecordType
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.
Parameters	`osid.type.Type`	`todoRecordType`	a todo record type
Return	`osid.checklist.TodoList`		the returned `Todo` list
Errors	NULL_ARGUMENT		`todoRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getTodosOnDate
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.
Parameters	`osid.calendaring.DateTime`	`from`	starting date
Parameters	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.checklist.TodoList`		the returned `Todo` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getTodosByPriority
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.
Parameters	`osid.type.Type`	`priorityType`	a priority type
Return	`osid.checklist.TodoList`		the returned `Todo` list
Errors	NULL_ARGUMENT		`priorityType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getTodosByDueDate
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.
Parameters	`osid.calendaring.DateTime`	`from`	starting date
Parameters	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.checklist.TodoList`		the returned `Todo` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getTodosByDependency
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.
Parameters	`osid.id.Id`	`dependencyTodoId`	a todo
Return	`osid.checklist.TodoList`		the returned `Todo` list
Errors	NULL_ARGUMENT		`dependencyTodoId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getTodos
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.
Return	`osid.checklist.TodoList`		a list of todos
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.