Package com.inductiveautomation.ignition.alarming.notification

Class AlarmNotificationProfileExtensionPoint<SettingsType>

java.lang.Object

com.inductiveautomation.ignition.gateway.config.AbstractExtensionPoint<SettingsType>

com.inductiveautomation.ignition.alarming.notification.AlarmNotificationProfileExtensionPoint<SettingsType>

All Implemented Interfaces:

ExtensionPoint<SettingsType>, Comparable<ExtensionPoint<SettingsType>>

public abstract class AlarmNotificationProfileExtensionPoint<SettingsType>
extends AbstractExtensionPoint<SettingsType>

Nested Class Summary

Nested classes/interfaces inherited from interface com.inductiveautomation.ignition.gateway.config.ExtensionPoint

ExtensionPoint.ComponentType

Field Summary

Fields inherited from class com.inductiveautomation.ignition.gateway.config.AbstractExtensionPoint

descriptionKey, gson, nameKey, typeId, validator

Fields inherited from interface com.inductiveautomation.ignition.gateway.config.ExtensionPoint

PROFILE_KEY, SETTINGS_KEY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AlarmNotificationProfileExtensionPoint(String typeId, String nameKey, String descriptionKey, @Nullable Class<SettingsType> settingsType)

Method Summary

Modifier and Type	Method	Description
AlarmNotificationProfile	createNewProfile(GatewayContext context, DecodedResource<ExtensionPointConfig<AlarmNotificationProfileConfig,?>> resource)
abstract AlarmNotificationProfile	createNewProfile(GatewayContext context, DecodedResource<ExtensionPointConfig<AlarmNotificationProfileConfig,?>> resource, SettingsType settings)
ResourceType	resourceType()	The resource type shared by all types of this extension point.
Optional<Class<SettingsType>>	settingsType()

Methods inherited from class com.inductiveautomation.ignition.gateway.config.AbstractExtensionPoint

addReferenceProperty, buildGson, buildValidator, customizeGson, decode, description, encode, getReferenceFinders, getSettingsValidator, name, typeId, validate

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.config.ExtensionPoint

canCreate, compareTo, defaultSettings, getMenuActions, getSettings, getWebUiComponent, settingsSchema

Constructor Details

AlarmNotificationProfileExtensionPoint

protected AlarmNotificationProfileExtensionPoint(String typeId,
 String nameKey,
 String descriptionKey,
 @Nullable
 @Nullable Class<SettingsType> settingsType)

Method Details

settingsType

public Optional<Class<SettingsType>> settingsType()

Returns:

the Class of the settings object for this ExtensionPoint, if it has one. If this ExtensionPoint does not have settings, return Optional.empty(). By default, this method returns the class of the object returned from ExtensionPoint.defaultSettings(), if one is provided.

createNewProfile

public AlarmNotificationProfile createNewProfile(GatewayContext context,
 DecodedResource<ExtensionPointConfig<AlarmNotificationProfileConfig,?>> resource)
                                          throws Exception

Throws:

Exception

createNewProfile

public abstract AlarmNotificationProfile createNewProfile(GatewayContext context,
 DecodedResource<ExtensionPointConfig<AlarmNotificationProfileConfig,?>> resource,
 SettingsType settings)
                                                   throws Exception

Throws:

Exception

resourceType

public ResourceType resourceType()

Description copied from interface: ExtensionPoint

The resource type shared by all types of this extension point. This is used to group extension points together. For example, all alarm journal types would share the same resource type, but have different typeIds.