Kanzi  3.9.8
Kanzi Engine Java API
ActivityHostConceptMetadata.ActivationMessageArguments Class Reference

Metadata definitions for ActivationMessageArguments. More...

Inheritance diagram for ActivityHostConceptMetadata.ActivationMessageArguments:
[legend]

Public Member Functions

 ActivationMessageArguments ()
 Construct a new messageArgumentsClassName instance.
 
 ActivationMessageArguments (long nativeObject)
 Wrap a native instance. More...
 
String getActivationPathProperty ()
 Getter for ActivationPathProperty.
 
Boolean getResetHistoryProperty ()
 Getter for ResetHistoryProperty.
 
void setActivationPathProperty (String value)
 Setter for ActivationPathProperty.
 
void setResetHistoryProperty (Boolean value)
 Setter for ResetHistoryProperty.
 
- Public Member Functions inherited from MessageArguments
 MessageArguments ()
 Constructs a new MessageArguments object. More...
 
TDataType getArgument (PropertyType< TDataType > propertyType)
 Returns the value of an argument. More...
 
TDataType getOptionalArgument (PropertyType< TDataType > propertyType)
 Returns the value of an argument, but does not use the default value if there are no inputs to the argument value. More...
 
TNodeType getSource ()
 Returns the source node for a message. More...
 
MessageArgumentsWrapper getWrapper ()
 Gets a wrapper for this MessageArguments. More...
 
boolean isHandled ()
 Returns whether the message is handled. More...
 
void setArgument (PropertyType< TDataType > propertyType, TDataType value)
 Sets the value of an argument. More...
 
void setArgument (PropertyType< Integer > propertyType, EnumType value)
 Sets the value of an integer argument using a constant from an enumeration. More...
 
void setHandled (boolean handled)
 Sets the handling status for a message. More...
 

Static Public Attributes

static final DynamicPropertyType< String > ActivationPathProperty
 The relative path from the target Activity Host to the Activity that you want to activate. More...
 
static final AbstractMetaclass metaclass
 Metaclass for ActivationMessageArguments. More...
 
static final DynamicPropertyType< Boolean > ResetHistoryProperty
 Determines whether Kanzi resets the Activity property values when an Activity becomes active: More...
 

Additional Inherited Members

- Static Public Member Functions inherited from MessageArguments
static MessageArgumentsWrapper getWrapper (MessageArguments messageArguments)
 Gets a wrapper for a MessageArguments object. More...
 
- Protected Member Functions inherited from MessageArguments
 MessageArguments (MessageArgumentsWrapper wrapper)
 Wraps a native message argument. More...
 
 MessageArguments (long nativeObject)
 Wraps a native message argument. More...
 

Detailed Description

Constructor & Destructor Documentation

ActivationMessageArguments ( long  nativeObject)

Wrap a native instance.

Parameters
nativeObjectReference to a native instance.

Member Data Documentation

final DynamicPropertyType<String> ActivationPathProperty
static
Initial value:
=
new DynamicPropertyType<>(
"ActivityHostConcept.ActivationMessageArguments.ActivationPath", String.class)

The relative path from the target Activity Host to the Activity that you want to activate.

final AbstractMetaclass metaclass
static
Initial value:
=
new AbstractMetaclass("Kanzi.ActivityHostConcept.ActivationMessageArguments")

Metaclass for ActivationMessageArguments.

final DynamicPropertyType<Boolean> ResetHistoryProperty
static
Initial value:
=
new DynamicPropertyType<>(
"ActivityHostConcept.ActivationMessageArguments.ResetHistory", Boolean.class)

Determines whether Kanzi resets the Activity property values when an Activity becomes active:

  • When enabled, Kanzi discards the serialized values of Activity properties for this Activity and its child Activities.
  • When disabled, Kanzi reinstates the serialized values of Activity properties of this Activity and its child Activities. The default value.