Interface | osid.authorization.VaultNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to | ||
Method | canRegisterForVaultNotifications | ||
Description |
Tests if this user can register for | ||
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 | ||
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 | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewVaults | ||
Description |
Register for notifications of new vaults. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedVaults | ||
Description |
Registers for notification of updated vaults. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedVault | ||
Description |
Registers for notification of an updated vault. | ||
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. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedVault | ||
Description |
Registers for notification of a deleted vault. | ||
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. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedVaultHierarchyForAncestors | ||
Description |
Registers for notification of an updated vault
hierarchy structure. | ||
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. | ||
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. |