OSID - osid.dictionary.EntryNotificationSession Service Interface Definition

Interface	osid.dictionary.EntryNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `Entry` objects within a `Dictionary.` 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	getDictionaryId
Description	Gets the `Dictionary` `Id` associated with this session.
Return	`osid.id.Id`		the `Dictionary` `Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getDictionary
Description	Gets the `Dictionary` associated with this session.
Return	`osid.dictionary.Dictionary`		the `Dictionary` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForEntryNotifications
Description	Tests if this user can register for `Entry` 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	useFederatedDictionaryView
Description	Federates the view for methods in this session. A federated view will include entries from parent dictionaries in the dictionary hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedDictionaryView
Description	Isolates the view for methods in this session. An isolated view restricts notifications for entries to this dictionary only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableEntryNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgEntryNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableEntryNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeEntryNotification
Description	Acknowledge an entry 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	registerForNewEntries
Description	Registers for notifications of new entries. `EntryReceiver.newEntries()` is invoked when a new `Entry` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewEntriesByKeyTypeAndValueType
Description	Registers for notifications of new entries by key and value types. `EntryReceiver.newEntries()` is invoked when a new `Entry` is created.
Parameters	`osid.type.Type`	`keyType`	the entry key type
Parameters	`osid.type.Type`	`valueType`	the entry key type
Errors	NULL_ARGUMENT		`keyType` or `valueType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedEntries
Description	Regsiters for notification of updated entries. `EntryReceiver.changedEntries()` is invoked when an `Entry` is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedEntriesByKeyTypeAndValueType
Description	Registers for notifications of an update to entries by key and value type `.` `EntryReceiver.changedEntries()` is invoked when the specified `Entry` is changed.
Parameters	`osid.type.Type`	`keyType`	the entry key type
Parameters	`osid.type.Type`	`valueType`	the entry key type
Errors	NULL_ARGUMENT		`keyType` or `valueType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedEntry
Description	Registers for notifications of an update to an `Entry.` `EntryReceiver.changedEntries()` is invoked when the specified `Entry` is changed.
Parameters	`osid.id.Id`	`entryId`	the entry `Id`
Errors	NULL_ARGUMENT		`entryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedEntries
Description	Registers for notification of deleted dictionaries. `EntryReceiver.deletedEntries()` is invoked when the specified `Entry` is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedEntriesByKeyTypeAndValueType
Description	Registers for notifications of a deleted entries by key and value type. `EntryReceiver.deletedEntries()` is invoked when the specified `Entry` is removed from this dictionary.
Parameters	`osid.type.Type`	`keyType`	the entry key type
Parameters	`osid.type.Type`	`valueTYpe`	the entry key type
Errors	NULL_ARGUMENT		`keyType or valueType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedEntry
Description	Registers for notifications of a deleted `Entry.` `EntryReceiver.deletedEntries()` is invoked when the specified `Entry` is removed from this dictionary.
Parameters	`osid.id.Id`	`entryId`	the entry `Id`
Errors	NULL_ARGUMENT		`entryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.