public interface BankNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Bank
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 |
canRegisterForBankNotifications()
Tests if this user can register for
Bank notifications. |
void |
registerForChangedBank(Id bankId)
Registers for notification of an updated bank.
|
void |
registerForChangedBanks()
Registers for notification of updated banks.
|
void |
registerForDeletedBank(Id bankId)
Registers for notification of a deleted bank.
|
void |
registerForDeletedBankAncestors(Id bankId)
Registers for notification if an ancestor is removed from the
specified bank in the bank hierarchy.
|
void |
registerForDeletedBankDescendants(Id bankId)
Registers for notification if a descendant is removed from fthe
specified bank in the bank hierarchy.
|
void |
registerForDeletedBanks()
Registers for notification of deleted banks.
|
void |
registerForNewBankAncestors(Id bankId)
Registers for notification if an ancestor is added to the specified
bank in the bank hierarchy.
|
void |
registerForNewBankDescendants(Id bankId)
Registers for notification if a descendant is added to the specified
bank in the bank hierarchy.
|
void |
registerForNewBanks()
Register for notifications of new banks.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canRegisterForBankNotifications()
Bank
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 registerForNewBanks() throws OperationFailedException, PermissionDeniedException
BankReceiver.newBank()
is invoked when a new Bank is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void registerForNewBankAncestors(Id bankId) throws OperationFailedException, PermissionDeniedException
BankReceiver.newBankAncestor()
is invoked when the specified bank experiences an addition in
ancestry.bankId
- the Id of the bank to monitorNullArgumentException
- bankId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void registerForNewBankDescendants(Id bankId) throws OperationFailedException, PermissionDeniedException
BankReceiver.newBankDescendant()
is invoked when the specified bank experiences an addition in
descendants.bankId
- the Id of the bank to monitorNullArgumentException
- bankId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void registerForChangedBanks() throws OperationFailedException, PermissionDeniedException
BankReceiver.changedBank()
is invoked when a bank is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void registerForChangedBank(Id bankId) throws OperationFailedException, PermissionDeniedException
BankReceiver.changedBank()
is invoked when the specified bank
is changed.bankId
- the Id of the bank to monitorNullArgumentException
- bankId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void registerForDeletedBanks() throws OperationFailedException, PermissionDeniedException
BankReceiver.deletedBank()
is invoked when a bank is deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void registerForDeletedBank(Id bankId) throws OperationFailedException, PermissionDeniedException
BankReceiver.deletedBank()
is invoked when the specified bank
is deleted.bankId
- the Id of the bank to monitorNullArgumentException
- bankId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void registerForDeletedBankAncestors(Id bankId) throws OperationFailedException, PermissionDeniedException
BankReceiver.deletedBankAncestor()
is invoked when the
specified bank experiences a removal of an ancestor.bankId
- the Id of the bank to monitorNullArgumentException
- bankId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void registerForDeletedBankDescendants(Id bankId) throws OperationFailedException, PermissionDeniedException
BankReceiver.deletedBankDescednant()
is invoked when the
specified bank experiences a removal of one of its descendants.bankId
- the Id of the bank to monitorNullArgumentException
- bankId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented.