Package com.inductiveautomation.ignition.common.alarming.config

Class BasicAlarmProperty<T>

java.lang.Object
com.inductiveautomation.ignition.common.alarming.config.BasicAlarmProperty<T>
All Implemented Interfaces:
AlarmProperty<T>, DescriptiveProperty<T>, Property<T>, Serializable
public class BasicAlarmProperty<T> extends Object implements AlarmProperty<T>
See Also:

  • Constructor Details

    • BasicAlarmProperty

      public BasicAlarmProperty()

    • BasicAlarmProperty

      public BasicAlarmProperty(AlarmProperty<T> base, String displayKey)

    • BasicAlarmProperty

      public BasicAlarmProperty(String name, Class<? extends T> type, T defaultVal, String displayKey, String categoryKey, String descKey, boolean bindable, boolean advanced)

  • Method Details

    • getDefaultVal

      public T getDefaultVal()

    • setDefaultVal

      public void setDefaultVal(T defaultVal)

    • setType

      public void setType(Class<? extends T> type)

    • setName

      public void setName(String name)

    • setDisplayKey

      public void setDisplayKey(String displayKey)

    • setCategoryKey

      public void setCategoryKey(String categoryKey)

    • setDescKey

      public void setDescKey(String descKey)

    • setBindable

      public void setBindable(boolean bindable)

    • setAdvanced

      public void setAdvanced(boolean advanced)

    • getType

      public Class<? extends T> getType()
      Description copied from interface: Property
      The data type for this property.
      Specified by:
      getType in interface Property<T>

    • getDefaultValue

      public T getDefaultValue()
      Description copied from interface: Property
      The default value for new instances of this property, or null if not applicable.
      Specified by:
      getDefaultValue in interface Property<T>

    • getName

      public String getName()
      Description copied from interface: Property
      The "name" of this property. Should be descriptive, but also unique. To this end, it is encouraged to make your keys fully qualified by prefixing them with your module id. For example: "mymod.MyProperty". Properties defined by the system start with "sys."
      Specified by:
      getName in interface Property<T>

    • getDisplayName

      public LocalizedString getDisplayName()
      Description copied from interface: DescriptiveProperty
      A friendly display name for the property. If not set, will return a raw LocalizedString that contains the property name.
      Specified by:
      getDisplayName in interface DescriptiveProperty<T>

    • getDisplayKey

      public String getDisplayKey()

    • getCategory

      public LocalizedString getCategory()
      Description copied from interface: DescriptiveProperty
      The category under which this property will be placed when editing.
      Specified by:
      getCategory in interface DescriptiveProperty<T>

    • getCategoryKey

      public String getCategoryKey()

    • getDescription

      public LocalizedString getDescription()
      Description copied from interface: DescriptiveProperty
      Optional description/documentation for the property. May return null if no information is available.
      Specified by:
      getDescription in interface DescriptiveProperty<T>

    • getDescKey

      public String getDescKey()

    • isBindable

      public boolean isBindable()
      Description copied from interface: AlarmProperty
      Indicates whether this property is allowed to be bound. If not, only simple values are allowed.
      Specified by:
      isBindable in interface AlarmProperty<T>

    • isAdvanced

      public boolean isAdvanced()
      Description copied from interface: AlarmProperty
      Indicates whether this property should not be shown on basic edit screens.
      Specified by:
      isAdvanced in interface AlarmProperty<T>

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object