OSID - osid.lexicon.TextNotificationSession Service Interface Definition

Interface	osid.lexicon.TextNotificationSession
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 `Texts` in this `Press` . This also includes existing texts 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 `TextLookupSession` .
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	canRegisterForTextNotifications
Description	Tests if this user can register for `Text` 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 texts 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	reliableTextNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeTextNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableTextNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeTextNotification
Description	Acknowledge a text 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	registerForNewTexts
Description	Register for notifications of new texts. `TextReceiver.newText()` is invoked when a new `Text` appears in this press.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedTexts
Description	Registers for notification of updated texts. `TextReceiver.changedText()` is invoked when a text 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	registerForChangedText
Description	Registers for notification of an updated text. `TextReceiver.changedText()` is invoked when the specified text 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	registerForDeletedTexts
Description	Registers for notification of deleted texts. `TextReceiver.deletedText()` is invoked when a text 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	registerForDeletedText
Description	Registers for notification of a deleted text. `TextReceiver.deletedText()` is invoked when the specified text is deleted or removed from this press.
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.