ConditionOrAction (java-api 21.0.11 API)

java.lang.Object
- com.uc4.api.objects.ConditionOrAction

Direct Known Subclasses:

AbortAction, BlockAction, CancelProcessFlowAction, ChangeQueueAction, CheckActivitiesCondition, CheckConnectionCondition, CheckFileCondition, CheckHistoryCondition, CheckProcessCondition, ClearVariableAction, CurrentQueueCondition, CurrentTimeCondition, ExecuteObjectAction, ModifyStateAction, PublishValueAction, ReEvaluateAtAction, ReEvaluateInAction, RestartTaskAction, ReturnCodeCondition, RollbackAction, RunPathAction, RunTaskAction, SetValueAction, SetVariableAction, SkipTaskAction, StatusCondition, TimeSinceActivationCondition, UserDefinedCondition
```
public abstract class ConditionOrAction
extends java.lang.Object
```
Base class of all Conditions or Actions.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static java.lang.String`	`PAR0`
`protected static java.lang.String`	`PAR1`
`protected static java.lang.String`	`PAR2`
`protected static java.lang.String`	`PAR3`
`protected java.util.Set<com.uc4.api.objects.ConditionOrAction.Param>`	`params`

Constructor Summary

Constructors
Constructor and Description

ConditionOrAction()

Constructors
Constructor and Description
`ConditionOrAction()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`ConditionOrAction`	`copy()` Creates a deep copy of this object
`static Action`	`createActionFromId(java.lang.String id)` Creates an action according to the id.
`static Condition`	`createConditionFromId(java.lang.String id)` Creates a condition according to the id.
`boolean`	`equals(java.lang.Object obj)`
`abstract int`	`getDisplayMessageID()`
`abstract java.lang.String`	`getId()`
`java.lang.String`	`getParameter(java.lang.String name)` Internal use only: Returns the value or message number of the specified parameter.
`abstract int`	`getParameterMessageID()`
`java.lang.String`	`getPromptName()`
`java.lang.String`	`getScriptName()`
`abstract int`	`getSkeletonMessageID()`
`int`	`hashCode()`
`abstract boolean`	`isAction()`
`boolean`	`isActive()`
`abstract boolean`	`isAfterCondition()`
`abstract boolean`	`isBeforeCondition()`
`abstract boolean`	`isIF()`
`boolean`	`isOnce()`
`boolean`	`isParameterAltView(java.lang.String name)` Returns `true` if the alternative view is enabled for the specified parameter If the parameter was not found `false` is returned.
`void`	`setActive(boolean active)` Activates or deactivates a condition.
`void`	`setOnce(boolean once)`
`void`	`setParameter(java.lang.String name, java.lang.String value, java.lang.String type)` Internal use only: Sets a condition parameter using the variable name and message number.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PAR0
```
protected static final java.lang.String PAR0
```
    See Also:
    
    Constant Field Values
  - PAR1
```
protected static final java.lang.String PAR1
```
    See Also:
    
    Constant Field Values
  - PAR2
```
protected static final java.lang.String PAR2
```
    See Also:
    
    Constant Field Values
  - PAR3
```
protected static final java.lang.String PAR3
```
    See Also:
    
    Constant Field Values
  - params
```
protected java.util.Set<com.uc4.api.objects.ConditionOrAction.Param> params
```
- Constructor Detail
  - ConditionOrAction
```
public ConditionOrAction()
```
- Method Detail
  - getId
```
public abstract java.lang.String getId()
```
    Returns:
    
    ID of the condition or action
  - isAction
```
public abstract boolean isAction()
```
    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 abstract boolean isBeforeCondition()
```
    Returns:
    
    true if the action/condition is allowed on the "Pre-Condition" tab
  - isAfterCondition
```
public abstract boolean isAfterCondition()
```
    Returns:
    
    true if the action/condition is allowed on the "Post-Condition" tab
  - isIF
```
public abstract boolean isIF()
```
    Returns:
    
    true if the action/condition is allowed in the condition of an IF workflow
  - getParameterMessageID
```
public abstract int getParameterMessageID()
```
    Returns:
    
    Message number of the parameter message
  - getSkeletonMessageID
```
public abstract int getSkeletonMessageID()
```
    Returns:
    
    Message number of this condition or action
  - getDisplayMessageID
```
public abstract int getDisplayMessageID()
```
    Returns:
    
    Message number for displaying this condition
  - createConditionFromId
```
public static Condition createConditionFromId(java.lang.String id)
```
    Creates a condition according to the id.
    
    Parameters:
    
    id - ID of the Condition
    
    Returns:
    
    Condition
  - createActionFromId
```
public static Action createActionFromId(java.lang.String id)
```
    Creates an action according to the id.
    
    Parameters:
    
    id - ID of the Action
    
    Returns:
    
    Action
  - getParameter
```
public java.lang.String getParameter(java.lang.String name)
```
    Internal use only: Returns the value or message number of the specified parameter.
    
    Parameters:
    
    name - Name of the script variable: XC_P01, XC_P02, XC_P03, XC_P04
    
    Returns:
    
    Value or an empty String if not found, never null
  - isParameterAltView
```
public boolean isParameterAltView(java.lang.String name)
```
    Returns true if the alternative view is enabled for the specified parameter If the parameter was not found false is returned.
    
    Parameters:
    
    name - Parameter name
    
    Returns:
    
    true if the alternative view for Script variables is enabled, false if this is not the case.
  - setParameter
```
public void setParameter(java.lang.String name,
                         java.lang.String value,
                         java.lang.String type)
```
    Internal use only: Sets a condition parameter using the variable name and message number.
    Parameters:
    
    name - Name of the script variable: XC_P01, XC_P02, XC_P03, XC_P04
    
    value - Value or a message number; example: "##911006"
    type - Parameter type:
    
    V ... Value type
    
    A ... Value type in alternative view; used if a the value contains an Automation Engine Script variable
  - getPromptName
```
public java.lang.String getPromptName()
```
    Returns:
    
    Name of the Prompt Script
  - getScriptName
```
public java.lang.String getScriptName()
```
    Returns:
    
    Name of the Include
  - isOnce
```
public boolean isOnce()
```
    Returns:
    
    true, if this condition should run once
  - setOnce
```
public void setOnce(boolean once)
```
    Parameters:
    
    once - true if this condition should run once
  - isActive
```
public boolean isActive()
```
    Returns:
    
    true if this condition is active
  - setActive
```
public void setActive(boolean active)
```
    Activates or deactivates a condition.
    
    Parameters:
    
    active - true if the condition should be active, false if the condition should be inactive
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - copy
```
public ConditionOrAction copy()
```
    Creates a deep copy of this object
    
    Returns:
    
    A copy of this object

Class ConditionOrAction

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PAR0

PAR1

PAR2

PAR3

params

Constructor Detail

ConditionOrAction

Method Detail

getId

isAction

isBeforeCondition

isAfterCondition

isIF

getParameterMessageID

getSkeletonMessageID

getDisplayMessageID

createConditionFromId

createActionFromId

getParameter

isParameterAltView

setParameter

getPromptName

getScriptName

isOnce

setOnce

isActive

setActive

hashCode

equals

copy