SetVariableAction (java-api 21.0.12 API)

java.lang.Object
- com.uc4.api.objects.ConditionOrAction
- - com.uc4.api.objects.SetVariableAction

All Implemented Interfaces:: Action

public class SetVariableAction
extends ConditionOrAction
implements Action

Sets the content of a static variable.

Field Summary
- Fields inherited from class com.uc4.api.objects.ConditionOrAction
  PAR0, PAR1, PAR2, PAR3, params

Constructor Summary

Constructors
Constructor and Description

SetVariableAction()
Creates a new SetVariableAction.

Constructors
Constructor and Description
`SetVariableAction()` Creates a new `SetVariableAction`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getDisplayMessageID()`
`java.lang.String`	`getId()`
`java.lang.String`	`getKey()`
`int`	`getParameterMessageID()`
`int`	`getSkeletonMessageID()`
`java.lang.String`	`getValue()`
`int`	`getValueColumn()`
`UC4ObjectName`	`getVariableName()`
`boolean`	`isAction()`
`boolean`	`isAfterCondition()` Returns `true` if this action can be used in a Pre-Condition.
`boolean`	`isBeforeCondition()` Returns `true` if this action can be used in a Post-Condition.
`boolean`	`isFinal()` Returns `true` if this is a final action in this condition.
`boolean`	`isIF()`
`void`	`setKey(java.lang.String key)`
`void`	`setValue(java.lang.String value)`
`void`	`setValueColumn(int valueColumn)`
`void`	`setVariableName(UC4ObjectName variableName)`

Methods inherited from class com.uc4.api.objects.ConditionOrAction
copy, createActionFromId, createConditionFromId, equals, getParameter, getPromptName, getScriptName, hashCode, isActive, isOnce, isParameterAltView, setActive, setOnce, setParameter

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SetVariableAction
```
public SetVariableAction()
```
    Creates a new SetVariableAction.
- Method Detail
  - setVariableName
```
public void setVariableName(UC4ObjectName variableName)
```
    Parameters:
    
    variableName - Name of the variable object
  - setKey
```
public void setKey(java.lang.String key)
```
    Parameters:
    
    key - Key value
  - setValueColumn
```
public void setValueColumn(int valueColumn)
```
    Parameters:
    
    valueColumn - Column which should store the new value
  - setValue
```
public void setValue(java.lang.String value)
```
    Parameters:
    
    value - New value
  - getVariableName
```
public UC4ObjectName getVariableName()
```
    Returns:
    
    Name of the variable object
  - getKey
```
public java.lang.String getKey()
```
    Returns:
    
    Key value
  - getValueColumn
```
public int getValueColumn()
```
    Returns:
    
    Column which should store the new value or -1 if not set.
  - getValue
```
public java.lang.String getValue()
```
    Returns:
    
    New value
  - isFinal
```
public boolean isFinal()
```
    Description copied from interface: Action
    
    Returns true if this is a final action in this condition.
    
    Specified by:
    
    isFinal in interface Action
    
    Returns:
    
    true if this action ends the evaluation of a condition
  - getId
```
public java.lang.String getId()
```
    Specified by:
    
    getId in interface Action
    
    Specified by:
    
    getId in class ConditionOrAction
    
    Returns:
    
    ID of the condition or action
  - isBeforeCondition
```
public boolean isBeforeCondition()
```
    Description copied from interface: Action
    
    Returns true if this action can be used in a Post-Condition.
    
    Specified by:
    
    isBeforeCondition in interface Action
    
    Specified by:
    
    isBeforeCondition in class ConditionOrAction
    
    Returns:
    
    true if the action/condition is allowed on the "Pre-Condition" tab
  - isAfterCondition
```
public boolean isAfterCondition()
```
    Description copied from interface: Action
    
    Returns true if this action can be used in a Pre-Condition.
    
    Specified by:
    
    isAfterCondition in interface Action
    
    Specified by:
    
    isAfterCondition in class ConditionOrAction
    
    Returns:
    
    true if the action/condition is allowed on the "Post-Condition" tab
  - isAction
```
public boolean isAction()
```
    Specified by:
    
    isAction in class ConditionOrAction
    
    Returns:
    
    true if the sub class is an instance of com.uc4.api.objects.Action or false if the sub class is an instance of com.uc4.api.objects.Condition
  - isIF
```
public boolean isIF()
```
    Specified by:
    
    isIF in class ConditionOrAction
    
    Returns:
    
    true if the action/condition is allowed in the condition of an IF workflow
  - getParameterMessageID
```
public int getParameterMessageID()
```
    Specified by:
    
    getParameterMessageID in class ConditionOrAction
    
    Returns:
    
    Message number of the parameter message
  - getSkeletonMessageID
```
public int getSkeletonMessageID()
```
    Specified by:
    
    getSkeletonMessageID in class ConditionOrAction
    
    Returns:
    
    Message number of this condition or action
  - getDisplayMessageID
```
public int getDisplayMessageID()
```
    Specified by:
    
    getDisplayMessageID in class ConditionOrAction
    
    Returns:
    
    Message number for displaying this condition

Class SetVariableAction

Field Summary

Fields inherited from class com.uc4.api.objects.ConditionOrAction

Constructor Summary

Method Summary

Methods inherited from class com.uc4.api.objects.ConditionOrAction

Methods inherited from class java.lang.Object

Constructor Detail

SetVariableAction

Method Detail

setVariableName

setKey

setValueColumn

setValue

getVariableName

getKey

getValueColumn

getValue

isFinal

getId

isBeforeCondition

isAfterCondition

isAction

isIF

getParameterMessageID

getSkeletonMessageID

getDisplayMessageID