public interface TriggerEnablerNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to TriggerEnabler
objects in this System.
This also includes existing TriggerEnablers
that may appear
or disappear due to changes in the System
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
TriggerEnablerLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeTriggerEnablerNotification(Id notificationId)
Acknowledge a trigger enabler notification.
|
boolean |
canRegisterForTriggerEnablerNotifications()
Tests if this user can register for
TriggerEnabler
notifications. |
System |
getSystem()
Gets the
System associated with this session. |
Id |
getSystemId()
Gets the
System Id associated with this
session. |
void |
registerForChangedTriggerEnabler(Id triggerEnablerId)
Registers for notification of an updated trigger enabler.
|
void |
registerForChangedTriggerEnablers()
Registers for notification of updated trigger enablers.
|
void |
registerForDeletedTriggerEnabler(Id triggerEnablerId)
Registers for notification of a deleted trigger enabler.
|
void |
registerForDeletedTriggerEnablers()
Registers for notification of deleted trigger enablers.
|
void |
registerForNewTriggerEnablers()
Register for notifications of new trigger enablers.
|
void |
reliableTriggerEnablerNotifications()
Reliable notifications are desired.
|
void |
unreliableTriggerEnablerNotifications()
Unreliable notifications are desired.
|
void |
useFederatedSystemView()
Federates the view for methods in this session.
|
void |
useIsolatedSystemView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getSystemId()
System
Id
associated with this
session. System Id
associated with this sessionmandatory
- This method must be implemented. System getSystem() throws OperationFailedException, PermissionDeniedException
System
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForTriggerEnablerNotifications()
TriggerEnabler
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 useFederatedSystemView()
mandatory
- This method is must be implemented. void useIsolatedSystemView()
mandatory
- This method is must be implemented. void reliableTriggerEnablerNotifications()
acknowledgeTriggerEnablerNotification()
.mandatory
- This method is must be implemented. void unreliableTriggerEnablerNotifications()
mandatory
- This method is must be implemented. void acknowledgeTriggerEnablerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewTriggerEnablers() throws OperationFailedException, PermissionDeniedException
TriggerEnablerReceiver.newTriggerEnablers()
is invoked when a
new TriggerEnabler
appears in this system.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedTriggerEnablers() throws OperationFailedException, PermissionDeniedException
TriggerEnablerReceiver.changedTriggerEnablers()
is invoked
when a trigger enabler in this system is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedTriggerEnabler(Id triggerEnablerId) throws OperationFailedException, PermissionDeniedException
ProvisionableReceiver.changedTriggerEnablers()
is invoked when
the specified trigger enabler in this system is changed.triggerEnablerId
- the Id
of the
TriggerEnabler
to monitorNullArgumentException
- triggerEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedTriggerEnablers() throws OperationFailedException, PermissionDeniedException
TriggerEnablerReceiver.deletedTriggerEnablers()
is invoked
when a trigger enabler is deleted or removed from this system.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedTriggerEnabler(Id triggerEnablerId) throws OperationFailedException, PermissionDeniedException
TriggerEnablerReceiver.deletedTriggerEnablers()
is invoked
when the specified trigger enabler is deleted or removed from this
system.triggerEnablerId
- the Id
of the
TriggerEnabler
to monitorNullArgumentException
- triggerEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.