OSID - osid.resourcing.rules.AvailabilityEnablerNotificationSession Service Interface Definition

Interface	osid.resourcing.rules.AvailabilityEnablerNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.resourcing.rules.ResourcingRulesManager`
Used By	`osid.resourcing.rules.ResourcingRulesProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `AvailabilityEnabler` objects in this `Foundry` . This also includes existing `AvailabilityEnablers` that may appear or disappear due to changes in the `Foundry` 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 `AvailabilityEnablerLookupSession` .
Method	getFoundryId
Description	Gets the `Foundry` `Id` associated with this session.
Return	`osid.id.Id`		the `Foundry Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getFoundry
Description	Gets the `Foundry` associated with this session.
Return	`osid.resourcing.Foundry`		the foundry
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForAvailabilityEnablerNotifications
Description	Tests if this user can register for `AvailabilityEnabler` 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	useFederatedFoundryView
Description	Federates the view for methods in this session. A federated view will include in foundries which are children of this foundry in the foundry hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedFoundryView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this foundry only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableAvailabilityEnablerNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeAvailabilityEnablerNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableAvailabilityEnablerNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeAvailabilityEnablerNotification
Description	Acknowledge an availability enabler 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	registerForNewAvailabilityEnablers
Description	Register for notifications of new availability enablers. `AvailabilityEnablerReceiver.newAvailabilityEnablers()` is invoked when a new `AvailabilityEnabler` appears in this foundry.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAvailabilityEnablers
Description	Registers for notification of updated foundries. `AvailabilityEnablerReceiver.changedAvailabilityEnablers()` is invoked when an availability enabler in this foundry is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAvailabilityEnabler
Description	Registers for notification of an updated availability enabler. `ProvisionableReceiver.changedAvailabilityEnablers()` is invoked when the specified availability enabler in this foundry is changed.
Parameters	`osid.id.Id`	`availabilityEnablerId`	the `Id` of the `AvailabilityEnabler` to monitor
Errors	NULL_ARGUMENT		`availabilityEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedAvailabilityEnablers
Description	Registers for notification of deleted availability enablers. `AvailabilityEnablerReceiver.deletedAvailabilityEnablers()` is invoked when an availability enabler is deleted or removed from this foundry.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedAvailabilityEnabler
Description	Registers for notification of a deleted availability enabler. `AvailabilityEnablerReceiver.deletedAvailabilityEnablers()` is invoked when the specified availability enabler is deleted or removed from this foundry.
Parameters	`osid.id.Id`	`availabilityEnablerId`	the `Id` of the `AvailabilityEnabler` to monitor
Errors	NULL_ARGUMENT		`availabilityEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.