OSID - osid.dictionary.DictionaryNotificationSession Service Interface Definition

Interface	osid.dictionary.DictionaryNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `Dictionary` 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.
Method	canRegisterForDictionaryNotifications
Description	Tests if this user can register for `Dictionary` 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	reliableDictionaryNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeDictionaryNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableDictionaryNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeDictionaryNotification
Description	Acknowledge a dictionary 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	registerForNewDictionaries
Description	Register for notifications of new dictionaries. `DictionaryReceiver.newDictionary()` is invoked when a new `Dictionary` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedDictionaries
Description	Registers for notification of updated dictionaries. `DictionaryReceiver.changedDictionaries()` is invoked when a dictionary is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedDictionary
Description	Registers for notification of an updated dictionary. `DictionaryReceiver.changedDictionaries()` is invoked when the specified dictionary is changed. A notification may be triggered for any updated, deleted or new dictionary the specified dictionary inherits data from.
Parameters	`osid.id.Id`	`dictionaryId`	the `Id` of the `Dictionary` to monitor
Errors	NULL_ARGUMENT		`dictionaryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedDictionaries
Description	Registers for notification of deleted dictionaries. `DictionaryReceiver.deletedDictionaries()` is invoked when a dictionary is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedDictionary
Description	Registers for notification of a deleted dictionary. `DictionaryReceiver.changedDictionaries()` is invoked when the specified dictionary is changed.
Parameters	`osid.id.Id`	`dictionaryId`	the `Id` of the `Dictionary` to monitor
Errors	NULL_ARGUMENT		`dictionaryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedDictionaryHierarchy
Description	Registers for notification of an updated dictionary hierarchy structure. `DictionaryReceiver.changedChildOfDictionaries()` 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	registerForChangedDictionaryHierarchyForAncestors
Description	Registers for notification of an updated dictionary hierarchy structure. `DictionaryReceiver.changedChildOfDictionaries()` is invoked when the specified node or any of its ancestors experiences a change in its children.
Parameters	`osid.id.Id`	`dictionaryId`	the `Id` of the `Dictionary` node to monitor
Errors	NULL_ARGUMENT		`dictionaryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedDictionaryHierarchyForDescendants
Description	Registers for notification of an updated dictionary hierarchy structure. `DictionaryReceiver.changedChildOfDictionaries()` is invoked when the specified node or any of its descendants experiences a change in its children.
Parameters	`osid.id.Id`	`dictionaryId`	the `Id` of the `Dictionary` node to monitor
Errors	NULL_ARGUMENT		`dictionaryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.