Package com.uc4.api.objects

Class RollbackAction

java.lang.Object

com.uc4.api.objects.ConditionOrAction

com.uc4.api.objects.RollbackAction

All Implemented Interfaces:

Action

public class RollbackAction
extends ConditionOrAction
implements Action

Rollback Action.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RollbackAction.Task	Task.

Field Summary

Fields inherited from class com.uc4.api.objects.ConditionOrAction

PAR0, PAR1, PAR2, PAR3, params

Constructor Summary

Constructors

Constructor	Description
RollbackAction()	Creates a new Rollback action.

Method Summary

Modifier and Type	Method	Description
int	getDisplayMessageID()
java.lang.String	getId()
int	getParameterMessageID()
int	getSkeletonMessageID()
RollbackAction.Task	getTask()	Returns the task to rollback.
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	setTask(RollbackAction.Task task)	Sets the task to rollback.
void	setTask(java.lang.String task)	Sets the task to rollback.

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

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RollbackAction

public RollbackAction()

Creates a new Rollback action.

Method Detail

getTask

public RollbackAction.Task getTask()

Returns the task to rollback.

Returns:

Task One of the enum constants defined in this class (THIS, PARENT, TOP)

setTask

public void setTask(java.lang.String task)

Sets the task to rollback.

Parameters:

task - One of the enum constants defined in this class (THIS, PARENT, TOP)

setTask

public void setTask(RollbackAction.Task task)

Sets the task to rollback.

Parameters:

task - One of the enum constants defined in this class (THIS, PARENT, TOP)

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 java.lang.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