Package com.uc4.api.objects
Class CancelProcessFlowAction
java.lang.Object
com.uc4.api.objects.ConditionOrAction
com.uc4.api.objects.CancelProcessFlowAction
- All Implemented Interfaces:
Action
Cancels a ProcessFlow without checking of further conditions.
-
Nested Class Summary
Nested Classes -
Field Summary
-
Constructor Summary
ConstructorsConstructorDescriptionCreates a newCancelProcessFlowAction
Action with OWN as Scope. -
Method Summary
Modifier and TypeMethodDescriptionint
getId()
int
getScope()
int
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()
boolean
void
setRecursive
(boolean recursive) void
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
-
CancelProcessFlowAction
public CancelProcessFlowAction()Creates a newCancelProcessFlowAction
Action with OWN as Scope.
-
-
Method Details
-
setScope
- Parameters:
scope
- One of the enum constants defined in this class (OWN, PARENT, TOP)
-
setRecursive
public void setRecursive(boolean recursive) - Parameters:
recursive
- true if the cancel should be recursive
-
getScope
- Returns:
- One of the enum constants defined in this class (OWN, PARENT, TOP)
-
isRecursive
public boolean isRecursive()- Returns:
- true if the cancel is recursive
-
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
-
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
-