OSID - osid.authorization.rules.AuthorizationEnablerNotificationSession Service Interface Definition

Interface	osid.authorization.rules.AuthorizationEnablerNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `AuthorizationEnabler` objects in this `Vault.` This also includes existing `AuthorizationEnablers` that may appear or disappear due to changes in the `Vault` 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 `AuthorizationEnablerLookupSession.`
Method	getVaultId
Description	Gets the `Vault` `Id` associated with this session.
Return	`osid.id.Id`		the `Vault Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getVault
Description	Gets the `Vault` associated with this session.
Return	`osid.authorization.Vault`		the vault
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForAuthorizationEnablerNotifications
Description	Tests if this user can register for `AuthorizationEnabler` 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	useFederatedVaultView
Description	Federates the view for methods in this session. A federated view will include enablers in vaults which are children of this vault in the vault hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedVaultView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this vault only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableAuthorizationEnablerNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeAuthorizationEnablerNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableAuthorizationEnablerNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeAuthorizationEnablerNotification
Description	Acknowledge an authorization 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	registerForNewAuthorizationEnablers
Description	Register for notifications of new authorization enablers. `AuthorizationEnablerReceiver.newAuthorizationEnablers()` is invoked when a new `AuthorizationEnabler` appears in this vault.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAuthorizationEnablers
Description	Registers for notification of updated authorization enablers. `AuthorizationEnablerReceiver.changedAuthorizationEnablers()` is invoked when an authorization enabler in this vault is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAuthorizationEnabler
Description	Registers for notification of an updated authorization enabler. `ProvisionableReceiver.changedAuthorizationEnablers()` is invoked when the specified authorization enabler in this vault is changed.
Parameters	`osid.id.Id`	`authorizationEnablerId`	the `Id` of the `AuthorizationEnabler` to monitor
Errors	NULL_ARGUMENT		`authorizationEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedAuthorizationEnablers
Description	Registers for notification of deleted authorization enablers. `AuthorizationEnablerReceiver.deletedAuthorizationEnablers()` is invoked when an authorization enabler is deleted or removed from this vault.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedAuthorizationEnabler
Description	Registers for notification of a deleted authorization enabler. `AuthorizationEnablerReceiver.deletedAuthorizationEnablers()` is invoked when the specified authorization enabler is deleted or removed from this vault.
Parameters	`osid.id.Id`	`authorizationEnablerId`	the `Id` of the `AuthorizationEnabler` to monitor
Errors	NULL_ARGUMENT		`authorizationEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.