public interface TriggerNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Trigger
objects in this System.
This also
includes existing triggers 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
TriggerLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeTriggerNotification(Id notificationId)
Acknowledge a trigger notification.
|
boolean |
canRegisterForTriggerNotifications()
Tests if this user can register for
Trigger
notifications. |
System |
getSystem()
Gets the
System associated with this session. |
Id |
getSystemId()
Gets the
System Id associated with this
session. |
void |
registerForChangedTrigger(Id triggerId)
Registers for notification of an updated trigger.
|
void |
registerForChangedTriggers()
Registers for notification of updated triggers.
|
void |
registerForChangedTriggersForController(Id controllerId)
Registers for notification of updated triggers for the given
controller.
|
void |
registerForDeletedTrigger(Id triggerId)
Registers for notification of a deleted trigger.
|
void |
registerForDeletedTriggers()
Registers for notification of deleted triggers.
|
void |
registerForDeletedTriggersForController(Id controllerId)
Registers for notification of deleted triggers for the given
controller.
|
void |
registerForNewTriggers()
Register for notifications of new triggers.
|
void |
registerForNewTriggersForController(Id controllerId)
Registers for notification of new triggers for the given controller.
|
void |
reliableTriggerNotifications()
Reliable notifications are desired.
|
void |
unreliableTriggerNotifications()
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 canRegisterForTriggerNotifications()
Trigger
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 reliableTriggerNotifications()
acknowledgeTriggerNotification()
.mandatory
- This method is must be implemented. void unreliableTriggerNotifications()
mandatory
- This method is must be implemented. void acknowledgeTriggerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewTriggers() throws OperationFailedException, PermissionDeniedException
TriggerReceiver.newTriggesr()
is invoked when a new
Trigger
appears in this system.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewTriggersForController(Id controllerId) throws OperationFailedException, PermissionDeniedException
TriggerReceiver.newTriggers()
is invoked a new
Trigger
appears in this system.controllerId
- the Id
of the Controller
to monitorNullArgumentException
- controllerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedTriggers() throws OperationFailedException, PermissionDeniedException
TriggerReceiver.changedTriggers()
is invoked when a trigger in
this system is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedTriggersForController(Id controllerId) throws OperationFailedException, PermissionDeniedException
TriggerReceiver.changedTriggers()
is
invoked when the specified trigger in this system is changed.controllerId
- the Id
of the Controller
to monitorNullArgumentException
- controllerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedTrigger(Id triggerId) throws OperationFailedException, PermissionDeniedException
TriggerReceiver.changedTriggers()
is invoked when the
specified trigger in this system is changed.triggerId
- the Id
of the Trigger
to monitorNullArgumentException
- triggerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedTriggers() throws OperationFailedException, PermissionDeniedException
TriggerReceiver.deletedTriggers()
is invoked when a trigger is
deleted or removed from this system.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedTriggersForController(Id controllerId) throws OperationFailedException, PermissionDeniedException
TriggerReceiver.deletedTrigger()
is invoked
when the specified trigger is deleted or removed from this system.controllerId
- the Id
of the Controller
to monitorNullArgumentException
- controllerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedTrigger(Id triggerId) throws OperationFailedException, PermissionDeniedException
TriggerReceiver.deletedTriggers()
is invoked when the
specified trigger is deleted or removed from this system.triggerId
- the Id
of the Trigger
to monitorNullArgumentException
- triggerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.