Package com.uc4.api.objects

Class SetValueAction

java.lang.Object
com.uc4.api.objects.ConditionOrAction
com.uc4.api.objects.SetValueAction
All Implemented Interfaces:
Action
public class SetValueAction extends ConditionOrAction implements Action
Sets or creates an object value which will be available for restarts.

  • Constructor Details

    • SetValueAction

      public SetValueAction()
      Creates a new SetValueAction.

  • Method Details

    • setName

      public void setName(String name)
      Parameters:
      name - Name of the value entry

    • setValue

      public void setValue(String value)
      Parameters:
      value - New value

    • setScope

      public void setScope(SetValueAction.Scope scope)
      Parameters:
      scope - Scope (TASK or PROCESS_FLOW)

    • getName

      public String getName()
      Returns:
      Name of the value entry

    • getValue

      public String getValue()
      Returns:
      New value

    • getScope

      public SetValueAction.Scope getScope()
      Returns:
      Scope (TASK or PROCESS_FLOW)

    • 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