public interface NotificationContext extends PropertySet
AlarmEvent
s that should be described in the
notification, as well as the user that should be notified.
Beyond providing information, the notification context is an important control mechanism. Profiles must call either
notificationDone()
or notificationFailed(LocalizedString)
when finished.
The NotificationContext extends PropertySet, and will contain the configured properties defined by the notification
profile.Modifier and Type | Method and Description |
---|---|
java.util.List<AlarmEvent> |
getAlarmEvents() |
java.util.EnumSet<DropoutCondition> |
getDropoutConditions() |
User |
getUser() |
void |
notificationDone()
Call when notification has been completed successfully.
|
void |
notificationFailed(LocalizedString failureMessage)
None of the
AlarmEvent s in this context could be sent due some underlying failure. |
getProperties, getValues
remove, set, set
contains, get, getOrDefault, getOrElse, isExtended, isInherited
java.util.List<AlarmEvent> getAlarmEvents()
AlarmEvent
s that triggered this notification.java.util.EnumSet<DropoutCondition> getDropoutConditions()
DropoutCondition
s configured on the pipeline.void notificationDone()
void notificationFailed(LocalizedString failureMessage)
AlarmEvent
s in this context could be sent due some underlying failure. If a fall-back
for the current AlarmPipeline
is defined, all events will be placed upon it for evaluation.failureMessage
- The reason for failure. This message will be user-facing in the pipeline status area if no fall-back is defined.