Package com.uc4.api.objects

Class ModifyStateAction

java.lang.Object
com.uc4.api.objects.ConditionOrAction
com.uc4.api.objects.ModifyStateAction
All Implemented Interfaces:
Action
public class ModifyStateAction extends ConditionOrAction implements Action
Sets return code without checking of further conditions. Additionally text can be entered. It will affect only ProcessFlow internal dependencies

  • Constructor Details

    • ModifyStateAction

      public ModifyStateAction()
      Creates a new ModifyStateAction.

  • Method Details

    • setRetCode

      public void setRetCode(int retCode)
      Sets the return code.
      Parameters:
      retCode - Return code

    • setText

      public void setText(String text)
      Sets the text.
      Parameters:
      text - text

    • getRetCode

      public int getRetCode()
      Returns:
      Return code

    • getText

      public String getText()
      Returns:
      Text

    • 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

    • 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

    • 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

    • 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