Interface TagEventScripts
-
- All Superinterfaces:
Countable
,Extendable<TagEventScripts>
,Mergable<TagEventScripts>
,java.io.Serializable
- All Known Implementing Classes:
BasicTagEventScripts
,ExtendedTagEventScripts
,TagEventScriptsDiff
,TagEventsScriptsConfig
public interface TagEventScripts extends java.io.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 Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description boolean
contains(java.lang.String eventId)
default TagEventScripts
extend(TagEventScripts parent)
If called on a child, gets the extension with the given parent.java.lang.String
get(java.lang.String eventId)
java.util.Set<java.lang.String>
getDefinedEvents()
default TagEventScripts
getExtension()
This returns an object that represents the value only for the most "local" level.boolean
isEventEnabled(java.lang.String eventId)
boolean
isInherited(java.lang.String eventId)
boolean
isOverridden(java.lang.String eventId)
default void
merge(TagEventScripts other, boolean localOnly)
Merges the values from other collection into this one.default TagEventScripts
newExtension()
Called on a base object, gets a new extension with a default config object for the child.void
remove(java.lang.String eventId)
void
set(java.lang.String eventId, java.lang.String code)
void
setEventEnabled(java.lang.String eventId, boolean enabled)
-
-
-
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)
-
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 interfaceExtendable<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 interfaceExtendable<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 interfaceExtendable<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 interfaceMergable<TagEventScripts>
-
-