Package com.inductiveautomation.ignition.alarming.notification

Class AlarmNotificationProfileType

java.lang.Object

com.inductiveautomation.ignition.gateway.model.BaseExtensionPointType

com.inductiveautomation.ignition.alarming.notification.AlarmNotificationProfileType

All Implemented Interfaces:

ExtensionPointType, Serializable, Comparable<ExtensionPointType>

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.

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.inductiveautomation.ignition.gateway.model.BaseExtensionPointType

description, name, typeId

Constructor Summary

Constructors

Constructor	Description
AlarmNotificationProfileType(String typeId, String nameKey, String descriptionKey)

Method Summary

Modifier and Type	Method	Description
abstract AlarmNotificationProfile	createNewProfile(GatewayContext context, AlarmNotificationProfileRecord profileRecord)	Create a new AlarmNotificationProfile given the settings indicated by settingsRecord.

Methods inherited from class com.inductiveautomation.ignition.gateway.model.BaseExtensionPointType

addRecordInstanceActions, compareTo, findProfileSettingsRecord, getDescription, getName, getSettingsRecordForeignKey, getTypeId, isEnabled, newRecordConfigPanel, onRecordDestroyed

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.inductiveautomation.ignition.gateway.model.ExtensionPointType

getSettingsRecordType

Constructor Details

AlarmNotificationProfileType

public AlarmNotificationProfileType(String typeId,
 String nameKey,
 String descriptionKey)

Parameters:

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.

Method Details

createNewProfile

public abstract AlarmNotificationProfile createNewProfile(GatewayContext context,
 AlarmNotificationProfileRecord profileRecord)
                                                   throws Exception

Create a new AlarmNotificationProfile given the settings indicated by settingsRecord.

Parameters:

profileRecord - The record defining the AlarmNotificationProfile to create.

context - The GatewayContext. Use this to find any associated settings records.

Returns:

A new AlarmNotificationProfile with the settings indicated by settingsRecord.

Throws:

Exception