com.uc4.api.objects

Class ClearVariableAction

java.lang.Object

com.uc4.api.objects.ConditionOrAction

com.uc4.api.objects.ClearVariableAction

All Implemented Interfaces:

Action

public class ClearVariableAction
extends ConditionOrAction
implements Action

Deletes the content of a static variable.

Constructor Summary

Constructors

Constructor and Description
ClearVariableAction() Creates a new ClearVariableAction.

Method Summary

Modifier and Type	Method and Description
int	getDisplayMessageID()
String	getId()
String	getKey()
int	getParameterMessageID()
int	getSkeletonMessageID()
UC4ObjectName	getVariableName() Returns the name of the Variable object.
boolean	isAction()
boolean	isAfterCondition() Returns true if this action can be used in a Pre-Condition.
boolean	isBeforeCondition() Returns true if this action can be used in a Post-Condition.
boolean	isFinal() Returns true if this is a final action in this condition.
boolean	isIF()
void	setKey(String key) 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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClearVariableAction

public ClearVariableAction()

Creates a new ClearVariableAction.

Method Detail

setVariableName

public void setVariableName(UC4ObjectName variableName)

Sets the name of the Variable object.

Parameters:

variableName - object name

setKey

public void setKey(String key)

Sets the key of the variable.

Parameters:

key - Key

getVariableName

public UC4ObjectName getVariableName()

Returns the name of the Variable object.

Returns:

object name

getKey

public String getKey()

Returns:

Key

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