Package com.inductiveautomation.ignition.alarming.common.notification

Class BasicNotificationProfileProperty<T>

java.lang.Object

com.inductiveautomation.ignition.common.config.BasicProperty<T>

com.inductiveautomation.ignition.common.config.BasicDescriptiveProperty<T>

com.inductiveautomation.ignition.common.config.BasicConfigurationProperty<T>

com.inductiveautomation.ignition.alarming.common.notification.BasicNotificationProfileProperty<T>

All Implemented Interfaces:

NotificationProfileProperty<T>, ConfigurationProperty<T>, DescriptiveProperty<T>, Property<T>, java.io.Serializable

public class BasicNotificationProfileProperty<T>
extends BasicConfigurationProperty<T>
implements NotificationProfileProperty<T>

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.inductiveautomation.ignition.common.config.ConfigurationProperty

ConfigurationProperty.CustomEditorDescriptor, ConfigurationProperty.Option<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	expressionSource
protected java.util.Collection<Property<?>>	variables

Constructor Summary

Constructors

Constructor	Description
BasicNotificationProfileProperty()	Bean compatibility...
BasicNotificationProfileProperty(java.lang.String name, java.lang.String displayNameKey, java.lang.String categoryKey, java.lang.Class<T> cls)
BasicNotificationProfileProperty(java.lang.String name, java.lang.String displayNameKey, java.lang.String categoryKey, java.lang.Class<T> cls, T defaultValue)

Method Summary

Modifier and Type	Method	Description
java.util.Collection<Property<?>>	getExpressionVariables()	If this property is an expression, these are the variables that can be referenced in the expression.
boolean	isExpressionSource()	If this property is to be considered the source of an expression, return true here so that the proper editor can be shown.
BasicNotificationProfileProperty<T>	setExpressionSource(boolean expressionSource)
BasicNotificationProfileProperty<T>	setExpressionVariables(java.util.Collection<Property<?>> variables)

Methods inherited from class com.inductiveautomation.ignition.common.config.BasicConfigurationProperty

getCustomEditor, getOptions, getValueDisplayBaseKey, setCustomEditor, setOptions

Methods inherited from class com.inductiveautomation.ignition.common.config.BasicDescriptiveProperty

getCategory, getCategoryKey, getDescription, getDescriptionKey, getDisplayName, getDisplayNameKey, setCategory, setDescription, setDisplayName

Methods inherited from class com.inductiveautomation.ignition.common.config.BasicProperty

equals, getClazz, getDefaultValue, getName, getType, hashCode, setClazz, setClazz_, setDefaultValue, setDefaultValue_, setName, setName_, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.inductiveautomation.ignition.common.config.ConfigurationProperty

getCustomEditor, getOptions, getValueDisplayBaseKey

Methods inherited from interface com.inductiveautomation.ignition.common.config.DescriptiveProperty

getCategory, getDescription, getDisplayName

Methods inherited from interface com.inductiveautomation.ignition.common.config.Property

getDefaultValue, getName, getType

Field Detail

expressionSource

protected boolean expressionSource

variables

protected java.util.Collection<Property<?>> variables

Constructor Detail

BasicNotificationProfileProperty

public BasicNotificationProfileProperty()

Bean compatibility...

BasicNotificationProfileProperty

public BasicNotificationProfileProperty(java.lang.String name,
                                        java.lang.String displayNameKey,
                                        java.lang.String categoryKey,
                                        java.lang.Class<T> cls,
                                        T defaultValue)

BasicNotificationProfileProperty

public BasicNotificationProfileProperty(java.lang.String name,
                                        java.lang.String displayNameKey,
                                        java.lang.String categoryKey,
                                        java.lang.Class<T> cls)

Method Detail

setExpressionSource

public BasicNotificationProfileProperty<T> setExpressionSource(boolean expressionSource)

isExpressionSource

public boolean isExpressionSource()

Description copied from interface: NotificationProfileProperty

If this property is to be considered the source of an expression, return true here so that the proper editor can be shown.

Specified by:

isExpressionSource in interface NotificationProfileProperty<T>

setExpressionVariables

public BasicNotificationProfileProperty<T> setExpressionVariables(java.util.Collection<Property<?>> variables)

getExpressionVariables

public java.util.Collection<Property<?>> getExpressionVariables()

Description copied from interface: NotificationProfileProperty

If this property is an expression, these are the variables that can be referenced in the expression. NOTE: Variables that are common to all AlarmEvents will already be included, so this list should only be variables specific to this property.

Specified by:

getExpressionVariables in interface NotificationProfileProperty<T>