Package com.uc4.api.objects
Class ClearVariableAction
java.lang.Object
com.uc4.api.objects.ConditionOrAction
com.uc4.api.objects.ClearVariableAction
- All Implemented Interfaces:
Action
Deletes the content of a static variable.
-
Field Summary
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
getId()
getKey()
int
int
Returns the name of the Variable object.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()
void
Sets the key of the variable.void
setVariableName
(UC4ObjectName variableName) Sets the name of the Variable object.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
-
ClearVariableAction
public ClearVariableAction()Creates a newClearVariableAction
.
-
-
Method Details
-
setVariableName
Sets the name of the Variable object.- Parameters:
variableName
- object name
-
setKey
Sets the key of the variable.- Parameters:
key
- Key
-
getVariableName
Returns the name of the Variable object.- Returns:
- object name
-
getKey
- Returns:
- Key
-
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
-