public interface SequenceRuleEnablerNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to SequenceRuleEnabler
objects in this Bank.
This also includes existing SequenceRuleEnablers
that may
appear or disappear due to changes in the Bank
hierarchy,
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
SequenceRuleEnablerLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeSequenceRuleEnablerNotification(Id notificationId)
Acknowledge a sequence rule enabler notification.
|
boolean |
canRegisterForSequenceRuleEnablerNotifications()
Tests if this user can register for
SequenceRuleEnabler
notifications. |
Bank |
getBank()
Gets the
Bank associated with this session. |
Id |
getBankId()
Gets the
Bank Id associated with this
session. |
void |
registerForChangedSequenceRuleEnabler(Id sequenceRuleEnablerId)
Registers for notification of an updated sequence rule enabler.
|
void |
registerForChangedSequenceRuleEnablers()
Registers for notification of updated bank enabelrs.
|
void |
registerForDeletedSequenceRuleEnabler(Id sequenceRuleEnablerId)
Registers for notification of a deleted sequence rule enabler.
|
void |
registerForDeletedSequenceRuleEnablers()
Registers for notification of deleted sequence rule enablers.
|
void |
registerForNewSequenceRuleEnablers()
Register for notifications of new sequence rule enablers.
|
void |
reliableSequenceRuleEnablerNotifications()
Reliable notifications are desired.
|
void |
unreliableSequenceRuleEnablerNotifications()
Unreliable notifications are desired.
|
void |
useFederatedBankView()
Federates the view for methods in this session.
|
void |
useIsolatedBankView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getBankId()
Bank
Id
associated with this
session. Bank Id
associated with this sessionmandatory
- This method must be implemented. Bank getBank() throws OperationFailedException, PermissionDeniedException
Bank
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForSequenceRuleEnablerNotifications()
SequenceRuleEnabler
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 useFederatedBankView()
mandatory
- This method is must be implemented. void useIsolatedBankView()
mandatory
- This method is must be implemented. void reliableSequenceRuleEnablerNotifications()
acknowledgeSequenceRuleEnablerNotification()
.mandatory
- This method is must be implemented. void unreliableSequenceRuleEnablerNotifications()
mandatory
- This method is must be implemented. void acknowledgeSequenceRuleEnablerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewSequenceRuleEnablers() throws OperationFailedException, PermissionDeniedException
SequenceRuleEnablerReceiver.newSequenceRuleEnablers()
is
invoked when a new SequenceRuleEnabler
appears in this
bank.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedSequenceRuleEnablers() throws OperationFailedException, PermissionDeniedException
SequenceRuleEnablerReceiver.changedSequenceRuleEnablers()
is
invoked when a sequence rule enabler in this bank is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedSequenceRuleEnabler(Id sequenceRuleEnablerId) throws OperationFailedException, PermissionDeniedException
ProvisionableReceiver.changedSequenceRuleEnablers()
is invoked
when the specified sequence rule enabler in this bank is changed.sequenceRuleEnablerId
- the Id
of the
SequenceRuleEnabler
to monitorNullArgumentException
- sequenceRuleEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedSequenceRuleEnablers() throws OperationFailedException, PermissionDeniedException
SequenceRuleEnablerReceiver.deletedSequenceRuleEnablers()
is
invoked when a sequence rule enabler is deleted or removed from this
bank.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedSequenceRuleEnabler(Id sequenceRuleEnablerId) throws OperationFailedException, PermissionDeniedException
SequenceRuleEnablerReceiver.deletedSequenceRuleEnablers()
is
invoked when the specified sequence rule enabler is deleted or removed
from this bank.sequenceRuleEnablerId
- the Id
of the
SequenceRuleEnabler
to monitorNullArgumentException
- sequenceRuleEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.