OSID - osid.sequencing.ChainNotificationSession Service Interface Definition

Interface	osid.sequencing.ChainNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `Chain` objects in this `dDstributor.` 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 `ChainLookupSession.`
Method	getAntimatroidId
Description	Gets the `Antimatroid` `Id` associated with this session.
Return	`osid.id.Id`		the `Antimatroid Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getAntimatroid
Description	Gets the `Antimatroid` associated with this session.
Return	`osid.sequencing.Antimatroid`		the antimatroid
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForChainNotifications
Description	Tests if this user can register for `Chain` 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	useFederatedAntimatroidView
Description	Federates the view for methods in this session. A federated view will include chains in antimatroids which are children of this antimatroid in the antimatroid hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedAntimatroidView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this antimatroid only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableChainNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeChainNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableChainNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeChainNotification
Description	Acknowledge a chain 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	registerForNewChains
Description	Register for notifications of new chains. `ChainReceiver.newChains()` is invoked when a new `Chain` appears in this antimatroid.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedChains
Description	Registers for notification of updated chains. `ChainReceiver.changedChains()` is invoked when a chain in this antimatroid is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedChain
Description	Registers for notification of an updated chain. `ChainReceiver.changedChains()` is invoked when the specified chain in this antimatroid is changed.
Parameters	`osid.id.Id`	`chainId`	the `Id` of the `Chain` to monitor
Errors	NULL_ARGUMENT		`chainId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedChains
Description	Registers for notification of deleted chains. `ChainReceiver.deletedChains()` is invoked when a chain is deleted or removed from this antimatroid.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedChain
Description	Registers for notification of a deleted chain. `ChainReceiver.deletedChains()` is invoked when the specified chain is deleted or removed from this antimatroid.
Parameters	`osid.id.Id`	`chainId`	the `Id` of the `Chain` to monitor
Errors	NULL_ARGUMENT		`chainId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.