Package com.uc4.api.objects
Class SetVariableAction
- java.lang.Object
-
- com.uc4.api.objects.ConditionOrAction
-
- com.uc4.api.objects.SetVariableAction
-
- All Implemented Interfaces:
Action
public class SetVariableAction extends ConditionOrAction implements Action
Sets the content of a static variable.
-
-
Constructor Summary
Constructors Constructor Description SetVariableAction()
Creates a newSetVariableAction
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
getDisplayMessageID()
java.lang.String
getId()
java.lang.String
getKey()
int
getParameterMessageID()
int
getSkeletonMessageID()
java.lang.String
getValue()
int
getValueColumn()
UC4ObjectName
getVariableName()
boolean
isAction()
boolean
isAfterCondition()
Returnstrue
if this action can be used in a Pre-Condition.boolean
isBeforeCondition()
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
setKey(java.lang.String key)
void
setValue(java.lang.String value)
void
setValueColumn(int valueColumn)
void
setVariableName(UC4ObjectName variableName)
-
Methods inherited from class com.uc4.api.objects.ConditionOrAction
copy, createActionFromId, createConditionFromId, equals, getParameter, getPromptName, getScriptName, hashCode, isActive, isOnce, isParameterAltView, setActive, setOnce, setParameter
-
-
-
-
Method Detail
-
setVariableName
public void setVariableName(UC4ObjectName variableName)
- Parameters:
variableName
- Name of the variable object
-
setKey
public void setKey(java.lang.String key)
- Parameters:
key
- Key value
-
setValueColumn
public void setValueColumn(int valueColumn)
- Parameters:
valueColumn
- Column which should store the new value
-
setValue
public void setValue(java.lang.String value)
- Parameters:
value
- New value
-
getVariableName
public UC4ObjectName getVariableName()
- Returns:
- Name of the variable object
-
getKey
public java.lang.String getKey()
- Returns:
- Key value
-
getValueColumn
public int getValueColumn()
- Returns:
- Column which should store the new value or
-1
if not set.
-
getValue
public java.lang.String getValue()
- Returns:
- New value
-
isFinal
public boolean isFinal()
Description copied from interface:Action
Returnstrue
if this is a final action in this condition.
-
getId
public java.lang.String getId()
- Specified by:
getId
in interfaceAction
- Specified by:
getId
in classConditionOrAction
- Returns:
- ID of the condition or action
-
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
-
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
-
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
-
-