Package com.uc4.api.objects

Class SetVariableAction

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.

  • Constructor Details

    • SetVariableAction

      public SetVariableAction()
      Creates a new SetVariableAction.

  • Method Details

    • setVariableName

      public void setVariableName(UC4ObjectName variableName)
      Parameters:
      variableName - Name of the variable object

    • setKey

      public void setKey(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(String value)
      Parameters:
      value - New value

    • getVariableName

      public UC4ObjectName getVariableName()
      Returns:
      Name of the variable object

    • getKey

      public String getKey()
      Returns:
      Key value

    • getValueColumn

      public int getValueColumn()
      Returns:
      Column which should store the new value or -1 if not set.

    • getValue

      public 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 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