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

All Implemented Interfaces:: Condition

public class ReturnCodeCondition
extends ConditionOrAction
implements Condition

Checks the return code of the task.

Field Summary
- Fields inherited from class com.uc4.api.objects.ConditionOrAction
  PAR0, PAR1, PAR2, PAR3, params

Constructor Summary

Constructors
Constructor Description

ReturnCodeCondition()
Creates a new ReturnCodeCondition.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addElse(ConditionOrAction item)`	Adds a condition or action to the list of conditions/actions which should be executed when this condition is false.
`void`	`addWhen(ConditionOrAction item)`	Adds a condition or action to the list of conditions/actions which should be executed when this condition is true.
`java.util.Iterator<ConditionOrAction>`	`elseIterator()`	The returned iterator can be used to get the actions/conditions which are executed when this condition is false.
`int`	`elseSize()`	Returns the number of action/conditions which should be executed when this condition is false.
`int`	`getDisplayMessageID()`
`java.lang.String`	`getId()`
`java.lang.String`	`getOperator()`	Returns the operator.
`int`	`getParameterMessageID()`
`int`	`getReturnCode()`
`int`	`getSkeletonMessageID()`
`boolean`	`isAction()`
`boolean`	`isAfterCondition()`
`boolean`	`isBeforeCondition()`
`boolean`	`isIF()`
`void`	`setOperator(java.lang.String operator)`	Sets the operator, one of "<", "<=", "=", ">", ">=", "<>" .
`void`	`setReturnCode(int returnCode)`	Sets the return code.
`java.util.Iterator<ConditionOrAction>`	`whenIterator()`	The returned iterator can be used to get the actions/conditions which are executed when this condition is true.
`int`	`whenSize()`	Returns the number of action/conditions which should be executed when this condition is true.

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
  - ReturnCodeCondition
```
public ReturnCodeCondition()
```
    Creates a new ReturnCodeCondition.
- Method Detail
  - setOperator
```
public void setOperator(java.lang.String operator)
```
    Sets the operator, one of "<", "<=", "=", ">", ">=", "<>" .
    
    Parameters:
    
    operator - Operator
  - setReturnCode
```
public void setReturnCode(int returnCode)
```
    Sets the return code.
    
    Parameters:
    
    returnCode - return code
  - getOperator
```
public java.lang.String getOperator()
```
    Returns the operator.
    
    Returns:
    
    Operator
  - getReturnCode
```
public int getReturnCode()
```
    Returns:
    
    Return code or -1 if it has not been set
  - isBeforeCondition
```
public boolean isBeforeCondition()
```
    Specified by:
    
    isBeforeCondition in interface Condition
    
    Specified by:
    
    isBeforeCondition in class ConditionOrAction
    
    Returns:
    
    true if the action/condition is allowed on the "Pre-Condition" tab
  - isAfterCondition
```
public boolean isAfterCondition()
```
    Specified by:
    
    isAfterCondition in interface Condition
    
    Specified by:
    
    isAfterCondition in class ConditionOrAction
    
    Returns:
    
    true if the action/condition is allowed on the "Post-Condition" tab
  - getId
```
public java.lang.String getId()
```
    Specified by:
    
    getId in interface Condition
    
    Specified by:
    
    getId in class ConditionOrAction
    
    Returns:
    
    ID of the condition or action
  - addWhen
```
public void addWhen(ConditionOrAction item)
```
    Description copied from interface: Condition
    
    Adds a condition or action to the list of conditions/actions which should be executed when this condition is true.
    
    Specified by:
    
    addWhen in interface Condition
    
    Parameters:
    
    item - Condition or Action
  - addElse
```
public void addElse(ConditionOrAction item)
```
    Description copied from interface: Condition
    
    Adds a condition or action to the list of conditions/actions which should be executed when this condition is false.
    
    Specified by:
    
    addElse in interface Condition
    
    Parameters:
    
    item - Condition or Action
  - whenSize
```
public int whenSize()
```
    Description copied from interface: Condition
    
    Returns the number of action/conditions which should be executed when this condition is true.
    
    Specified by:
    
    whenSize in interface Condition
    
    Returns:
    
    Number of conditions/actions
  - elseSize
```
public int elseSize()
```
    Description copied from interface: Condition
    
    Returns the number of action/conditions which should be executed when this condition is false.
    
    Specified by:
    
    elseSize in interface Condition
    
    Returns:
    
    Number of conditions/actions
  - whenIterator
```
public java.util.Iterator<ConditionOrAction> whenIterator()
```
    Description copied from interface: Condition
    
    The returned iterator can be used to get the actions/conditions which are executed when this condition is true. The remove() method of the java.util.Iterator can be used to remove conditions or actions.
    
    Specified by:
    
    whenIterator in interface Condition
    
    Returns:
    
    Iterator
  - elseIterator
```
public java.util.Iterator<ConditionOrAction> elseIterator()
```
    Description copied from interface: Condition
    
    The returned iterator can be used to get the actions/conditions which are executed when this condition is false. The remove() method of the java.util.Iterator can be used to remove conditions or actions.
    
    Specified by:
    
    elseIterator in interface Condition
    
    Returns:
    
    Iterator
  - 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
  - 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

Class ReturnCodeCondition

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

ReturnCodeCondition

Method Detail

setOperator

setReturnCode

getOperator

getReturnCode

isBeforeCondition

isAfterCondition

getId

addWhen

addElse

whenSize

elseSize

whenIterator

elseIterator

isAction

isIF

getParameterMessageID

getSkeletonMessageID

getDisplayMessageID