OSID - osid.checklist.ChecklistNotificationSession Service Interface Definition

Interface	osid.checklist.ChecklistNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `Checklist` objects. 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. Notifications are triggered with changes to the `Checklist` object itself. Adding and removing todos result in notifications available from the notification session for todos.
Method	canRegisterForChecklistNotifications
Description	Tests if this user can register for `Checklist` 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	reliableChecklistNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeChecklistNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableChecklistNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeChecklistNotification
Description	Acknowledge a checklist 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	registerForNewChecklists
Description	Register for notifications of new checklists. `ChecklistReceiver.newChecklists()` is invoked when a new `Checklist` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedChecklists
Description	Registers for notification of updated checklists. `ChecklistReceiver.changedChecklists()` is invoked when a checklist is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedChecklist
Description	Registers for notification of an updated checklist. `ChecklistReceiver.changedChecklists()` is invoked when the specified checklist is changed.
Parameters	`osid.id.Id`	`checklistId`	the `Id` of the `Checklist` to monitor
Errors	NULL_ARGUMENT		`checklistId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedChecklists
Description	Registers for notification of deleted checklists. `ChecklistReceiver.deletedChecklists()` is invoked when a checklist is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedChecklist
Description	Registers for notification of a deleted checklist. `ChecklistReceiver.deletedChecklists()` is invoked when the specified checklist is deleted.
Parameters	`osid.id.Id`	`checklistId`	the `Id` of the `Checklist` to monitor
Errors	NULL_ARGUMENT		`checklistId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedChecklistHierarchy
Description	Registers for notification of an updated checklist hierarchy structure. `ChecklistReceiver.changedChildOfChecklists()` 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	registerForChangedChecklistHierarchyForAncestors
Description	`ChecklistReceiver.changedChildOfChecklists()` is invoked when the specified node or any of its ancestors experiences a change in its children.
Parameters	`osid.id.Id`	`checklistId`	the `Id` of the `Checklist` node to monitor
Errors	NULL_ARGUMENT		`checklistId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedChecklistHierarchyForDescendants
Description	Registers for notification of an updated checklist hierarchy structure. `ChecklistReceiver.changedChildOfChecklists()` is invoked when the specified node or any of its descendants experiences a change in its children.
Parameters	`osid.id.Id`	`checklistId`	the `Id` of the `Checklist` node to monitor
Errors	NULL_ARGUMENT		`checklistId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.