OSID - osid.authorization.QualifierNotificationSession Service Interface Definition

Interface	osid.authorization.QualifierNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.authorization.AuthorizationManager`
Used By	`osid.authorization.AuthorizationProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Qualifier` objects in this `Vault`. 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 `QualifierLookupSession`.
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` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForQualifierNotifications
Description	Tests if this user can register for `Qualifier` 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 notifications for qualifiers 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 for qualifiers to this vault only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableQualifierNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeQualifierNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableQualifierNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeQualifierNotification
Description	Acknowledge a qualifier 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	registerForNewQualifiers
Description	Register for notifications of new qualifiers. `QualifierReceiver.newQualifiers()` is invoked when a new `Qualifier` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedQualifiers
Description	Registers for notification of updated qualifiers. `QualifierReceiver.changedQualifiers()` is invoked when a qualifier is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedQualifier
Description	Registers for notification of an updated qualifier. `QualifierReceiver.changedQualifiers()` is invoked when the specified qualifier is changed.
Parameters	`osid.id.Id`	`qualifierId`	the `Id` of the `Qualifier` to monitor
Errors	NULL_ARGUMENT		`qualifierId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedQualifiers
Description	Registers for notification of deleted qualifiers. `QualifierReceiver.deletedQualifiers()` is invoked when a qualifier is removed from this vault.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedQualifier
Description	Registers for notification of a deleted qualifier. `QualifierReceiver.deletedQualifiers()` is invoked when the specified qualifier is removed from this vault.
Parameters	`osid.id.Id`	`qualifierId`	the `Id` of the `Qualifier` to monitor
Errors	NULL_ARGUMENT		`qualifierId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedQualifierHierarchy
Description	Registers for notification of an updated qualifier hierarchy structure. `QualifierReceiver.changedChildOfQualfiers()` 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	registerForChangedQualifierHierarchyForAncestors
Description	Registers for notification of an updated qualifier hierarchy structure. `QualifierReceiver.changedChildOfQualifiers()` is invoked when the specified node or any of its ancestors experiences a change in its children.
Parameters	`osid.id.Id`	`qualifierId`	the `Id` of the `Qualifier` node to monitor
Errors	NULL_ARGUMENT		`qualifierId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedQualifierHierarchyForDescendants
Description	Registers for notification of an updated qualifier hierarchy structure. `QualifierReceiver.changedChildOfQualifiers()` is invoked when the specified node or any of its descendants experiences a change in its children.
Parameters	`osid.id.Id`	`qualifierId`	the `Id` of the `Qualifier` node to monitor
Errors	NULL_ARGUMENT		`qualifierId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.