OSID - osid.lexicon.PressNotificationSession Service Interface Definition

Interface	osid.lexicon.PressNotificationSession
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 `Presses`. 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	canRegisterForPressNotifications
Description	Tests if this user can register for `Press` 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	reliablePressNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgePressNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliablePressNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgePressNotification
Description	Acknowledge a press 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 is must be implemented.
Method	registerForNewPresses
Description	Register for notifications of new presses. `PressReceiver.newPress()` is invoked when a new `Press` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedPresses
Description	Registers for notification of updated presses. `PressReceiver.changedPress()` is invoked when an press is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedPress
Description	Registers for notification of an updated press. `PressReceiver.changedPress()` is invoked when the specified press is changed.
Parameters	`osid.id.Id`	`pressId`	the Id of the `Press` to monitor
Errors	NULL_ARGUMENT		`pressId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedPresses
Description	Registers for notification of deleted presses. `PressReceiver.deletedPress()` is invoked when an press is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedPress
Description	Registers for notification of a deleted press. `PressReceiver.deletedPress()` is invoked when the specified press is deleted.
Parameters	`osid.id.Id`	`pressId`	the `Id` of the `Press` to monitor
Errors	NULL_ARGUMENT		`pressId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedPressHierarchy
Description	Registers for notification of an updated press hierarchy structure. `PressReceiver.changedChildOfPresses()` is invoked when the specified node or any of its descendants 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	registerForChangedPressHierarchyForAncestors
Description	Registers for notification of an updated press hierarchy structure. `PressReceiver.changedChildOfPresses()` is invoked when the specified node or any of its descendants experiences a change in its children.
Parameters	`osid.id.Id`	`pressId`	the `Id` of the `Press` node to monitor
Errors	NULL_ARGUMENT		`pressId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedPressHierarchyForDescendants
Description	Registers for notification of an updated press hierarchy structure. PressReceiver.changedChildOfPresses() is invoked when the specified node or any of its descendants experiences a change in its children.
Parameters	`osid.id.Id`	`pressId`	the `Id` of the `Press` node to monitor
Errors	NULL_ARGUMENT		`pressId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.