Package com.uc4.api.objects
Class ExecuteObjectAction
java.lang.Object
com.uc4.api.objects.ConditionOrAction
com.uc4.api.objects.ExecuteObjectAction
Starts any Automation Engine object. Does not check how the object being started ends.
-
Field Summary
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetAlias()
Returns the alias ornull
if none is set.int
getId()
getName()
Returns the parameter of this task.int
int
boolean
isAction()
boolean
Returnstrue
if this action can be used in a Pre-Condition.boolean
Returnstrue
if this action can be used in a Post-Condition.boolean
isFinal()
Returnstrue
if this is a final action in this condition.boolean
isIF()
boolean
isWait()
Returnstrue
if waiting for the task to finish is enabled.void
Sets the alias of the task.void
setName
(UC4ObjectName name) Sets the name of the Automation Engine object.void
setParameter
(Map<String, String> map) Sets the parameter (Prompt values).void
setWait
(boolean wait) Wait for the task to finish?Methods inherited from class com.uc4.api.objects.ConditionOrAction
copy, createActionFromId, createConditionFromId, equals, getParameter, getPromptName, getScriptName, hashCode, isActive, isOnce, isParameterAltView, setActive, setOnce, setParameter
-
Constructor Details
-
ExecuteObjectAction
public ExecuteObjectAction()Creates a newExecuteObjectAction
.
-
-
Method Details
-
setName
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
Sets the parameter (Prompt values).- Parameters:
map
- Parameter in a Map, key is the variable name
-
getParameter
Returns the parameter of this task.- Returns:
- Parameter or
null
if not set.
-
getName
- Returns:
- name of the Automation Engine object
-
isWait
public boolean isWait()Returnstrue
if waiting for the task to finish is enabled.- Returns:
- true if the condition waits until the task has finished
-
setAlias
Sets the alias of the task.- Parameters:
alias
- Alias
-
getAlias
Returns the alias ornull
if none is set. -
isFinal
public boolean isFinal()Description copied from interface:Action
Returnstrue
if this is a final action in this condition. -
getId
- Specified by:
getId
in interfaceAction
- Specified by:
getId
in classConditionOrAction
- Returns:
- ID of the condition or action
-
isAction
public boolean isAction()- Specified by:
isAction
in classConditionOrAction
- Returns:
- true if the sub class is an instance of
com.uc4.api.objects.Action
or false if the sub class is an instance ofcom.uc4.api.objects.Condition
-
isBeforeCondition
public boolean isBeforeCondition()Description copied from interface:Action
Returnstrue
if this action can be used in a Post-Condition.- Specified by:
isBeforeCondition
in interfaceAction
- Specified by:
isBeforeCondition
in classConditionOrAction
- Returns:
- true if the action/condition is allowed on the "Pre-Condition" tab
-
isAfterCondition
public boolean isAfterCondition()Description copied from interface:Action
Returnstrue
if this action can be used in a Pre-Condition.- Specified by:
isAfterCondition
in interfaceAction
- Specified by:
isAfterCondition
in classConditionOrAction
- Returns:
- true if the action/condition is allowed on the "Post-Condition" tab
-
isIF
public boolean isIF()- Specified by:
isIF
in classConditionOrAction
- Returns:
- true if the action/condition is allowed in the condition of an IF workflow
-
getParameterMessageID
public int getParameterMessageID()- Specified by:
getParameterMessageID
in classConditionOrAction
- Returns:
- Message number of the parameter message
-
getSkeletonMessageID
public int getSkeletonMessageID()- Specified by:
getSkeletonMessageID
in classConditionOrAction
- Returns:
- Message number of this condition or action
-
getDisplayMessageID
public int getDisplayMessageID()- Specified by:
getDisplayMessageID
in classConditionOrAction
- Returns:
- Message number for displaying this condition
-