public interface VaultNotificationSession extends OsidSession
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.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForVaultNotifications()
Tests if this user can register for
Vault
notifications. |
void |
registerForChangedVault(Id vaultId)
Registers for notification of an updated vault.
|
void |
registerForChangedVaults()
Registers for notification of updated vaults.
|
void |
registerForDeletedVault(Id vaultId)
Registers for notification of a deleted vault.
|
void |
registerForDeletedVaultAncestors(Id vaultId)
Registers for notification if an ancestor is removed from the
specified vault in the vault hierarchy.
|
void |
registerForDeletedVaultDescendants(Id vaultId)
Registers for notification if a descendant is removed from fthe
specified vault in the vault hierarchy.
|
void |
registerForDeletedVaults()
Registers for notification of deleted vaults.
|
void |
registerForNewVaultAncestors(Id vaultId)
Registers for notification if an ancestor is added to the specified
vault in the vault hierarchy.
|
void |
registerForNewVaultDescendants(Id vaultId)
Registers for notification if a descendant is added to the specified
vault in the vault hierarchy.
|
void |
registerForNewVaults()
Register for notifications of new vaults.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canRegisterForVaultNotifications()
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. false
if notification methods are not
authorized, true
otherwisemandatory
- This method must be implemented. void registerForNewVaults() throws OperationFailedException, PermissionDeniedException
VaultReceiver.newVault()
is invoked when a new Vault
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewVaultAncestors(Id vaultId) throws OperationFailedException, PermissionDeniedException
VaultReceiver.newVaultAncestor()
is invoked when the specified vault experiences an addition in
ancestry.vaultId
- the Id
of the vault to monitorNullArgumentException
- vaultId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewVaultDescendants(Id vaultId) throws OperationFailedException, PermissionDeniedException
VaultReceiver.newVaultDescendant()
is invoked when the
specified vault experiences an addition in descendants.vaultId
- the Id
of the vault to monitorNullArgumentException
- vaultId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedVaults() throws OperationFailedException, PermissionDeniedException
VaultReceiver.changedVault()
is invoked when a vault is
changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedVault(Id vaultId) throws OperationFailedException, PermissionDeniedException
VaultReceiver.changedVault()
is invoked when the specified
vault is changed.vaultId
- the Id of the vault to monitorNullArgumentException
- vaultId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedVaults() throws OperationFailedException, PermissionDeniedException
VaultReceiver.deletedVault()
is invoked when a vault is
deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedVault(Id vaultId) throws OperationFailedException, PermissionDeniedException
VaultReceiver.deletedVault()
is invoked when the specified
vault is deleted.vaultId
- the Id of the vault to monitorNullArgumentException
- vaultId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedVaultAncestors(Id vaultId) throws OperationFailedException, PermissionDeniedException
VaultReceiver.deletedVaultAncestor()
is invoked when the
specified vault experiences a removal of an ancestor.vaultId
- the Id of the vault to monitorNullArgumentException
- vaultId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedVaultDescendants(Id vaultId) throws OperationFailedException, PermissionDeniedException
VaultReceiver.deletedVaultDescednant()
is invoked when the
specified vault experiences a removal of one of its descendants.vaultId
- the Id of the vault to monitorNullArgumentException
- vaultId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.