Package com.inductiveautomation.ignition.common.sqltags.model.scripts

Interface TagEventScripts

All Superinterfaces:
Countable, Extendable<TagEventScripts>, Mergable<TagEventScripts>, Serializable
All Known Implementing Classes:
BasicTagEventScripts, ExtendedTagEventScripts, TagEventScriptsDiff, TagEventsScriptsConfig
public interface TagEventScripts extends Serializable, Countable, Mergable<TagEventScripts>, Extendable<TagEventScripts>
The tag event scripts are python code that execute for certain events. The events are defined by their "id", and depend on the system that is executing the tag.

In addition to maintaining the scripts, this object also tracks whether or not they are "enabled", in order to let users temporarily disable defined scripts.

  • Method Details

    • get

      String get(String eventId)

    • set

      void set(String eventId, String code)

    • contains

      boolean contains(String eventId)

    • remove

      void remove(String eventId)

    • isOverridden

      boolean isOverridden(String eventId)

    • isInherited

      boolean isInherited(String eventId)

    • getDefinedEvents

      Set<String> getDefinedEvents()

    • isEventEnabled

      boolean isEventEnabled(String eventId)

    • setEventEnabled

      void setEventEnabled(String eventId, boolean enabled)

    • newExtension

      default TagEventScripts newExtension()
      Description copied from interface: Extendable
      Called on a base object, gets a new extension with a default config object for the child.
      Specified by:
      newExtension in interface Extendable<TagEventScripts>

    • extend

      default TagEventScripts extend(TagEventScripts parent)
      Description copied from interface: Extendable
      If called on a child, gets the extension with the given parent.
      Specified by:
      extend in interface Extendable<TagEventScripts>

    • getExtension

      default TagEventScripts getExtension()
      Description copied from interface: Extendable
      This returns an object that represents the value only for the most "local" level. That is, this is the difference between the inherited base and the current extension. Complex objects should ensure that trait is true for all aspects of the returned value.
      Specified by:
      getExtension in interface Extendable<TagEventScripts>

    • merge

      default void merge(TagEventScripts other, boolean localOnly)
      Description copied from interface: Mergable
      Merges the values from other collection into this one. Replaces any currently existing value with those from the other set.
      Specified by:
      merge in interface Mergable<TagEventScripts>