OSID - osid.lexicon.IdiomNotificationSession Service Interface Definition

Interface	osid.lexicon.IdiomNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.lexicon.LexiconManager`
Used By	`osid.lexicon.LexiconProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Idioms` in this `Press` . This also includes existing idioms that may appear or disappear due to changes in the `Press` hierarchy, 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. The two views defined in this session correspond to the views in the `IdiomLookupSession` .
Method	getPressId
Description	Gets the `Press` `Id` associated with this session.
Return	`osid.id.Id`		the `Press Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getPress
Description	Gets the `Press` associated with this session.
Return	`osid.lexicon.Press`		the press
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForIdiomNotifications
Description	Tests if this user can register for `Idiom` 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 press 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	useFederatedPressView
Description	Federates the view for methods in this session. A federated view will include idioms in presses which are children of this press in the press hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedPressView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this press only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableIdionNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeIdiomNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableIdiomNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeIdiomNotification
Description	Acknowledge an idiom 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	registerForNewIdioms
Description	Register for notifications of new idioms. `IdiomReceiver.newIdiom()` is invoked when a new `Idiom` appears in this press.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewIdiomsForText
Description	Register for notifications of new idioms for the given text `Id` . `IdiomReceiver.newIdiom()` is invoked when a new `Idiom` is created.
Parameters	`osid.id.Id`	`textId`	the `Id` of the text to monitor
Errors	NULL_ARGUMENT		`textId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedIdioms
Description	Registers for notification of updated idioms. `IdiomReceiver.changedIdiom()` is invoked when an idiom in this press is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedIdiomsForText
Description	Register for notifications of updated idioms for the given text `Id` . `IdiomReceiver.changedIdiom()` is invoked when an idiom in this press is changed.
Parameters	`osid.id.Id`	`textId`	the `Id` of the text to monitor
Errors	NULL_ARGUMENT		`textId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedIdiom
Description	Registers for notification of an updated idiom. `IdiomReceiver.changedIdiom()` is invoked when the specified idiom in this press is changed.
Parameters	`osid.id.Id`	`idiomId`	the `Id` of the `Idiom` to monitor
Errors	NULL_ARGUMENT		`idiomId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedIdioms
Description	Registers for notification of deleted idioms. `IdiomReceiver.deletedIdiom()` is invoked when an idiom is deleted or removed from this press.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedIdiomsForText
Description	Register for notifications of deleted idioms for the given text `Id` . `IdiomReceiver.deletedIdiom()` is invoked when an idiom in this press is removed or deleted.
Parameters	`osid.id.Id`	`textId`	the `Id` of the text to monitor
Errors	NULL_ARGUMENT		`textId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedIdiom
Description	Registers for notification of a deleted idiom. `IdiomReceiver.deletedIdiom()` is invoked when the specified idiom is deleted or removed from this press.
Parameters	`osid.id.Id`	`idiomId`	the `Id` of the `Idiom` to monitor
Errors	NULL_ARGUMENT		`idiomId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.