OSID - osid.authorization.VaultNotificationSession Service Interface Definition

Interface	osid.authorization.VaultNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `Vault` 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.
Method	canRegisterForVaultNotifications
Description	Tests if this user can register for `Vault` 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	reliableVaultNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeVaultNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableVaultNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeVaultNotification
Description	Acknowledge a vault 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	registerForNewVaults
Description	Register for notifications of new vaults. `VaultReceiver.newVaults()` is invoked when a new `Vault` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedVaults
Description	Registers for notification of updated vaults. `VaultReceiver.changedVaults()` is invoked when a vault is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedVault
Description	Registers for notification of an updated vault. `VaultReceiver.changedVaults()` is invoked when the specified vault is changed.
Parameters	`osid.id.Id`	`vaultId`	the Id of the vault to monitor
Errors	NULL_ARGUMENT		`vaultId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedVaults
Description	Registers for notification of deleted vaults. `VaultReceiver.deletedVaults()` is invoked when a vault is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedVault
Description	Registers for notification of a deleted vault. `VaultReceiver.deletedVaults()` is invoked when the specified vault is deleted.
Parameters	`osid.id.Id`	`vaultId`	the Id of the vault to monitor
Errors	NULL_ARGUMENT		`vaultId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedVaultHierarchy
Description	Registers for notification of an updated vault hierarchy structure. `VaultReceiver.changedChildOfVaults()` 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	registerForChangedVaultHierarchyForAncestors
Description	Registers for notification of an updated vault hierarchy structure. `VaultReceiver.changedChildOfVaults()` is invoked when the specified node or any of its ancestors experiences a change in its children.
Parameters	`osid.id.Id`	`vaultId`	the `Id` of the `Vault` node to monitor
Errors	NULL_ARGUMENT		`vaultId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedVaultHierarchyForDescendants
Description	Registers for notification of an updated vault hierarchy structure. `VaultReceiver.changedChildOfVaults()` is invoked when the specified node or any of its descendants experiences a change in its children.
Parameters	`osid.id.Id`	`vaultId`	the `Id` of the `Vault` node to monitor
Errors	NULL_ARGUMENT		`vaultId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.