OSID - osid.checklist.TodoNotificationSession Service Interface Definition

Interface	osid.checklist.TodoNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.checklist.ChecklistManager`
Used By	`osid.checklist.ChecklistProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Todos`. This session is intended for consumers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this session is closed.
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	canRegisterForTodoNotifications
Description	Tests if this user can register for `Todo` notifications. 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 notification operations.
Return	`boolean`		`false` if notification methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedChecklistView
Description	Federates the view for methods in this session. A federated view will include notifications for todoss 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 notifications to this checklist only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableTodoNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeTodoNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableTodoNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeTodoNotification
Description	Acknowledge a todo notification.
Parameters	`osid.id.Id`	`notificationId`	the `Id` of the notification
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewTodos
Description	Register for notifications of new todos. `TodoReceiver.newTodos()` is invoked when a new `Todo` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedTodos
Description	Registers for notification of updated todos. `TodoReceiver.changedTodos()` is invoked when a todo is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedTodo
Description	Registers for notification of an updated todo. `TodoReceiver.changedTodos()` is invoked when the specified todo is changed.
Parameters	`osid.id.Id`	`todoId`	the `Id` of the `Todo` to monitor
Errors	NULL_ARGUMENT		`todoId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedTodos
Description	Registers for notification of deleted todos. `TodoReceiver.deletedTodos()` is invoked when a todo is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedTodo
Description	Registers for notification of a deleted todo. `TodoReceiver.deletedTodos()` is invoked when the specified todo is deleted.
Parameters	`osid.id.Id`	`todoId`	the `Id` of the `Todo` to monitor
Errors	NULL_ARGUMENT		`todoId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedTodoHierarchy
Description	Todo `Receiver.changedChildOfTodos()` is invoked when a node experiences a change in its children.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedTodoHierarchyForAncestors
Description	Registers for notification of an updated toto hierarchy structure. `TodoReceiver.changedChildOfTodos()` is invoked when the specified node or any of its ancestors experiences a change in its children.
Parameters	`osid.id.Id`	`todoId`	the `Id` of the `Todo` node to monitor
Errors	NULL_ARGUMENT		`todoId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedTodoHierarchyForDescendants
Description	Registers for notification of an updated todo hierarchy structure. `TodoReceiver.changedChildOfTodos()` is invoked when the specified node or any of its descendants experiences a change in its children.
Parameters	`osid.id.Id`	`todoId`	the `Id` of the `Todo` node to monitor
Errors	NULL_ARGUMENT		`todoId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.