Package com.uc4.api.objects

Class ExecuteObjectAction

java.lang.Object
com.uc4.api.objects.ConditionOrAction
com.uc4.api.objects.ExecuteObjectAction
All Implemented Interfaces:
HasAlias, Action
public class ExecuteObjectAction extends ConditionOrAction implements Action, HasAlias
Starts any Automation Engine object. Does not check how the object being started ends.

  • Constructor Details

    • ExecuteObjectAction

      public ExecuteObjectAction()
      Creates a new ExecuteObjectAction.

  • Method Details

    • setName

      public void setName(UC4ObjectName name)
      Sets the name of the Automation Engine object.
      Parameters:
      name - Name

    • setWait

      public void setWait(boolean wait)
      Wait for the task to finish?
      Parameters:
      wait - true if the condition should wait until the task has finished, false if the task exection should only be triggered

    • setParameter

      public void setParameter(Map<String,String> map)
      Sets the parameter (Prompt values).
      Parameters:
      map - Parameter in a Map, key is the variable name

    • getParameter

      public Map<String,String> getParameter()
      Returns the parameter of this task.
      Returns:
      Parameter or null if not set.

    • getName

      public UC4ObjectName getName()
      Returns:
      name of the Automation Engine object

    • isWait

      public boolean isWait()
      Returns true if waiting for the task to finish is enabled.
      Returns:
      true if the condition waits until the task has finished

    • setAlias

      public void setAlias(UC4Alias alias)
      Sets the alias of the task.
      Parameters:
      alias - Alias

    • getAlias

      public UC4Alias getAlias()
      Returns the alias or null if none is set.
      Specified by:
      getAlias in interface HasAlias
      Returns:
      Alias

    • 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