OSID - osid.control.SystemNotificationSession Service Interface Definition

Interface	osid.control.SystemNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.control.ControlManager`
Used By	`osid.control.ControlProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Systems`. 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	canRegisterForSystemNotifications
Description	Tests if this user can register for `System` 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	reliableSystemNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeSystemNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableSystemNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeSystemNotification
Description	Acknowledge a system 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	registerForNewSystems
Description	Register for notifications of new systems. `SystemReceiver.newSystems()` is invoked when a new `System` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedSystems
Description	Registers for notification of updated systems. `SystemReceiver.changedSystems()` is invoked when a system is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedSystem
Description	Registers for notification of an updated system. `SystemReceiver.changedSystems()` is invoked when the specified system is changed.
Parameters	`osid.id.Id`	`systemId`	the Id of the `System` to monitor
Errors	NULL_ARGUMENT		`systemId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedSystems
Description	Registers for notification of deleted systems. `SystemReceiver.deletedSystems()` is invoked when a system is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedSystem
Description	Registers for notification of a deleted system. `SystemReceiver.deletedSystems()` is invoked when the specified system is deleted.
Parameters	`osid.id.Id`	`systemId`	the `Id` of the `System` to monitor
Errors	NULL_ARGUMENT		`systemId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedSystemHierarchy
Description	Registers for notification of an updated system hierarchy structure. `SystemReceiver.changedChildOfSystems()` is invoked when a node 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	registerForChangedSystemHierarchyForAncestors
Description	Registers for notification of an updated system hierarchy structure. `SystemReceiver.changedChildOfSystems()` is invoked when the specified node or any of its ancestors experiences a change in its children.
Parameters	`osid.id.Id`	`systemId`	the `Id` of the `System` node to monitor
Errors	NULL_ARGUMENT		`systemId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedSystemHierarchyForDescendants
Description	Registers for notification of an updated system hierarchy structure. `SystemReceiver.changedChildOfSystems()` is invoked when the specified node or any of its descendants experiences a change in its children.
Parameters	`osid.id.Id`	`systemId`	the `Id` of the `System` node to monitor
Errors	NULL_ARGUMENT		`systemId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.