Kanzi 3.9.10
ApplyActivationAction Class Reference

An ApplyActivationAction keeps an Activity node activated for as long as the condition is met in a DataTrigger that contains this action. More...

Inheritance diagram for ApplyActivationAction:
[legend]

Static Public Member Functions

static ObjectRef< ApplyActivationActioncreate (Domain domain, String name)
 Creates an instance of ApplyActivationAction.
 

Static Public Attributes

static final Metaclass metaclass
 The Metaclass for the class.
 
- Static Public Attributes inherited from ApplyAction
static final Metaclass metaclass
 The Metaclass for the class.
 
- Static Public Attributes inherited from ActionBase
static final Metaclass metaclass
 The Metaclass for the class.
 
- Static Public Attributes inherited from KanziObject
static final Metaclass metaclass = new AbstractMetaclass("Kanzi.Object")
 The Metaclass for the class.
 

Additional Inherited Members

- Public Member Functions inherited from ActionBase
String getName ()
 Gets the name of an action.
 
- Public Member Functions inherited from KanziObject
boolean equals (Object object)
 
Domain getDomain ()
 Returns the domain the object belongs to.
 
Metaclass getDynamicMetaclass ()
 Returns the metaclass of the dynamic type of the object.
 
long getNative ()
 Gets a pointer to the backing C++ instance.
 
TDataType getOptionalProperty (PropertyType< TDataType > propertyType)
 Returns the current value of a property type, but does not use the default value if there are no inputs to the property value.
 
TDataType getProperty (PropertyType< TDataType > propertyType)
 Returns the current value of a property type.
 
int hashCode ()
 
boolean hasValue (PropertyType< TDataType > propertyType)
 Evaluates whether there are any inputs into the property value.
 
boolean isStale ()
 Test if the object is stale i.e.
 
void removeLocalValue (PropertyType< TDataType > propertyType)
 Removes the local value associated with the property.
 
void setProperty (PropertyType< TDataType > propertyType, TDataType value)
 Sets the local value of a property type.
 
ObjectRef< TType > tryCreateObjectRef (Class< TType > clazz)
 Tries to create an owning ObjectRef instance to this KanziObject.
 
- Public Attributes inherited from ActionBaseMetadata
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.ActionBase")
 Metaclass for ActionBase.
 
- Public Attributes inherited from ApplyActionMetadata
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.ApplyAction")
 Metaclass for ApplyAction.
 
- Public Attributes inherited from ApplyActivationActionMetadata
DynamicPropertyType< String > ActivationPathProperty
 The activation path from the Activity Host, which is set as the target of this action, to the Activity node you want to activate.
 
DynamicPropertyType< String > ActivityHostPathProperty
 Path to the Activity Host node of the activated Activity node.
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.ApplyActivationAction")
 Metaclass for ApplyActivationAction.
 

Detailed Description

An ApplyActivationAction keeps an Activity node activated for as long as the condition is met in a DataTrigger that contains this action.

When the trigger condition is no longer met, Kanzi rolls back the state of the Activity node to the state before the action was applied. Use the ApplyActivationAction only with a DataTrigger.

Member Function Documentation

◆ create()

static ObjectRef< ApplyActivationAction > create ( Domain domain,
String name )
static

Creates an instance of ApplyActivationAction.

Parameters
domainPointer to the domain.
nameName for the action instance.
Returns
handle to the created ApplyActivationAction instance.

Member Data Documentation

◆ metaclass

final Metaclass metaclass
static
Initial value:
=
com.rightware.kanzi.metadata.ApplyActivationActionMetadata.metaclass

The Metaclass for the class.