OSID - osid.authentication.keys.KeyNotificationSession Service Interface Definition

Interface	osid.authentication.keys.KeyNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive asynchronous notifications on adds/changes to `Key` objects. 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 `KeyLookupSession.`
Method	getAgencyId
Description	Gets the `Agency` `Id` associated with this session.
Return	`osid.id.Id`		the `Agency Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getAgency
Description	Gets the `Agency` associated with this session.
Return	`osid.authentication.Agency`		the `Agency` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForKeyNotifications
Description	Tests if this user can register for `Key` 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	useFederatedAgencyView
Description	Federates the view for methods in this session. A federated view will include keys in agencies which are children of this agency in the agency hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedAgencyView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this agency only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableKeyNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeKeyNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableKeyNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeKeyNotification
Description	Acknowledge a key 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	registerForNewKeys
Description	Register for notifications of new keys. `KeyReceiver.newKeys()` is invoked when a new `Key` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedKeys
Description	Registers for notification of updated keys. `KeyReceiver.changedKeys()` is invoked when an key is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedKey
Description	Registers for notification of an updated key. `KeyReceiver.changedKeys()` is invoked when the specified key is changed.
Parameters	`osid.id.Id`	`keyId`	the `Id` of the `Key` to monitor
Errors	NULL_ARGUMENT		`keyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedKeys
Description	Registers for notification of deleted keys. `KeyReceiver.deletedKeys()` is invoked when an key is removed from this agency.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedKey
Description	Registers for notification of a deleted key. `KeyReceiver.deletedKeys()` is invoked when the specified key is removed from this agency.
Parameters	`osid.id.Id`	`keyId`	the `Id` of the `Key` to monitor
Errors	NULL_ARGUMENT		`keyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.