Package com.uc4.api.objects

Class CancelProcessFlowAction

java.lang.Object
com.uc4.api.objects.ConditionOrAction
com.uc4.api.objects.CancelProcessFlowAction
All Implemented Interfaces:
Action
public class CancelProcessFlowAction extends ConditionOrAction implements Action
Cancels a ProcessFlow without checking of further conditions.

  • Constructor Details

    • CancelProcessFlowAction

      public CancelProcessFlowAction()
      Creates a new CancelProcessFlowAction Action with OWN as Scope.

  • Method Details

    • setScope

      public void setScope(CancelProcessFlowAction.Scope scope)
      Parameters:
      scope - One of the enum constants defined in this class (OWN, PARENT, TOP)

    • setRecursive

      public void setRecursive(boolean recursive)
      Parameters:
      recursive - true if the cancel should be recursive

    • getScope

      public CancelProcessFlowAction.Scope getScope()
      Returns:
      One of the enum constants defined in this class (OWN, PARENT, TOP)

    • isRecursive

      public boolean isRecursive()
      Returns:
      true if the cancel is recursive

    • 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