public abstract class AlarmNotificationProfileType extends BaseExtensionPointType
An extension point for adding new alarm notification mechanisms to Ignition, e.g., email, SMS, or voice.
New notification mechanisms will provide a subclass of AlarmNotificationProfileType
with an implementation of
createNewProfile(GatewayContext, AlarmNotificationProfileRecord)
that can instantiate an AlarmNotificationProfile
implementation that encapsulates the behavior of this new notification mechanism.
description, name, typeId
Constructor and Description |
---|
AlarmNotificationProfileType(java.lang.String typeId,
java.lang.String nameKey,
java.lang.String descriptionKey) |
Modifier and Type | Method and Description |
---|---|
abstract AlarmNotificationProfile |
createNewProfile(GatewayContext context,
AlarmNotificationProfileRecord profileRecord)
Create a new
AlarmNotificationProfile given the settings indicated by settingsRecord. |
addRecordInstanceActions, compareTo, findProfileSettingsRecord, getDescription, getName, getSettingsRecordForeignKey, getTypeId, isEnabled, newRecordConfigPanel, onRecordDestroyed
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getSettingsRecordType
public AlarmNotificationProfileType(java.lang.String typeId, java.lang.String nameKey, java.lang.String descriptionKey)
typeId
- A unique ID identifying this extension point type.nameKey
- The key used to retrieve a name for this profile from BundleUtil
.descriptionKey
- The key used to retrieve a description for this profile from BundleUtil
.public abstract AlarmNotificationProfile createNewProfile(GatewayContext context, AlarmNotificationProfileRecord profileRecord) throws java.lang.Exception
AlarmNotificationProfile
given the settings indicated by settingsRecord.profileRecord
- The record defining the AlarmNotificationProfile
to create.context
- The GatewayContext
. Use this to find any associated settings records.AlarmNotificationProfile
with the settings indicated by settingsRecord.java.lang.Exception