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

Interface TagEventScripts

All Superinterfaces:

Countable, Mergable<TagEventScripts>, java.io.Serializable

All Known Implementing Classes:

BasicTagEventScripts, ExtendedTagEventScripts, TagEventScriptsDiff, TagEventsScriptsConfig

public interface TagEventScripts
extends java.io.Serializable, Countable, Mergable<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 Summary

Modifier and Type	Method and Description
boolean	contains(java.lang.String eventId)
java.lang.String	get(java.lang.String eventId)
java.util.Set<java.lang.String>	getDefinedEvents()
boolean	isEventEnabled(java.lang.String eventId)
boolean	isInherited(java.lang.String eventId)
boolean	isOverridden(java.lang.String eventId)
void	remove(java.lang.String eventId)
void	set(java.lang.String eventId, java.lang.String code)
void	setEventEnabled(java.lang.String eventId, boolean enabled)

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

getCount

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

merge

Method Detail

get

java.lang.String get(java.lang.String eventId)

set

void set(java.lang.String eventId,
         java.lang.String code)

contains

boolean contains(java.lang.String eventId)

remove

void remove(java.lang.String eventId)

isOverridden

boolean isOverridden(java.lang.String eventId)

isInherited

boolean isInherited(java.lang.String eventId)

getDefinedEvents

java.util.Set<java.lang.String> getDefinedEvents()

isEventEnabled

boolean isEventEnabled(java.lang.String eventId)

setEventEnabled

void setEventEnabled(java.lang.String eventId,
                     boolean enabled)