OSID - osid.lexicon.ParameterNotificationSession Service Interface Definition

Interface	osid.lexicon.ParameterNotificationSession
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 `Parameters` in this `Press` . This also includes existing parameters 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 `ParameterLookupSession` .
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	canRegisterForParameterNotifications
Description	Tests if this user can register for `Parameter` 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 parameters 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	reliableParameterNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeParameterNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableParameterNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeParameterNotification
Description	Acknowledge a parameter 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	registerForNewParameters
Description	Register for notifications of new parameters. `ParameterReceiver.newParameter()` is invoked when a new `Parameter` appears in this press.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewParametersForText
Description	Register for notifications of new parameters for the given text. `ParameterReceiver.newParameter()` is invoked when a new `Parameter` appears in 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.
Method	registerForChangedParameters
Description	Registers for notification of updated parameters. `ParameterReceiver.changedParameter()` is invoked when a parameter 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	registerForChangedParametersForText
Description	Register for notifications of updated parameters for the given text. `ParameterReceiver.changedParameter()` is invoked when a `Parameter` 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	registerForChangedParameter
Description	Registers for notification of an updated parameter. `AffiliationReceiver.changedParameter()` is invoked when the specified parameter in this press is changed.
Parameters	`osid.id.Id`	`parameterId`	the `Id` of the `Parameter` to monitor
Errors	NULL_ARGUMENT		`parameterId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedParameters
Description	Registers for notification of deleted parameters. `ParameterReceiver.deletedParameter()` is invoked when a parameter 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	registerForDeletedParametersForText
Description	Register for notifications of deleted parameters for the given text. `ParameterReceiver.deletedParameter()` is invoked when a `Parameter` 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.
Method	registerForDeletedParameter
Description	Registers for notification of a deleted parameter. `ParameterReceiver.deletedParameter()` is invoked when the specified parameter is deleted or removed from this press.
Parameters	`osid.id.Id`	`parameterId`	the `Id` of the `Parameter` to monitor
Errors	NULL_ARGUMENT		`parameterId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.