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 intgetDisplayMessageID()java.lang.StringgetId()java.lang.StringgetKey()intgetParameterMessageID()intgetSkeletonMessageID()java.lang.StringgetValue()intgetValueColumn()UC4ObjectNamegetVariableName()booleanisAction()booleanisAfterCondition()Returnstrueif this action can be used in a Pre-Condition.booleanisBeforeCondition()Returnstrueif this action can be used in a Post-Condition.booleanisFinal()Returnstrueif this is a final action in this condition.booleanisIF()voidsetKey(java.lang.String key)voidsetValue(java.lang.String value)voidsetValueColumn(int valueColumn)voidsetVariableName(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
-1if not set.
-
getValue
public java.lang.String getValue()
- Returns:
- New value
-
isFinal
public boolean isFinal()
Description copied from interface:ActionReturnstrueif this is a final action in this condition.
-
getId
public java.lang.String getId()
- Specified by:
getIdin interfaceAction- Specified by:
getIdin classConditionOrAction- Returns:
- ID of the condition or action
-
isBeforeCondition
public boolean isBeforeCondition()
Description copied from interface:ActionReturnstrueif this action can be used in a Post-Condition.- Specified by:
isBeforeConditionin interfaceAction- Specified by:
isBeforeConditionin classConditionOrAction- Returns:
- true if the action/condition is allowed on the "Pre-Condition" tab
-
isAfterCondition
public boolean isAfterCondition()
Description copied from interface:ActionReturnstrueif this action can be used in a Pre-Condition.- Specified by:
isAfterConditionin interfaceAction- Specified by:
isAfterConditionin classConditionOrAction- Returns:
- true if the action/condition is allowed on the "Post-Condition" tab
-
isAction
public boolean isAction()
- Specified by:
isActionin classConditionOrAction- Returns:
- true if the sub class is an instance of
com.uc4.api.objects.Actionor false if the sub class is an instance ofcom.uc4.api.objects.Condition
-
isIF
public boolean isIF()
- Specified by:
isIFin classConditionOrAction- Returns:
- true if the action/condition is allowed in the condition of an IF workflow
-
getParameterMessageID
public int getParameterMessageID()
- Specified by:
getParameterMessageIDin classConditionOrAction- Returns:
- Message number of the parameter message
-
getSkeletonMessageID
public int getSkeletonMessageID()
- Specified by:
getSkeletonMessageIDin classConditionOrAction- Returns:
- Message number of this condition or action
-
getDisplayMessageID
public int getDisplayMessageID()
- Specified by:
getDisplayMessageIDin classConditionOrAction- Returns:
- Message number for displaying this condition
-
-