ExecutionState (IQM 3.5 API)

java.lang.Object
- at.mug.iqm.api.processing.ExecutionState

```
public final class ExecutionState
extends Object
```
This class defines a list of subsequent execution states.

Author:

Philipp Kainz

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ERROR` The state, when the protocol encountered errors.
`static int`	`FINISHED` The state, when the operator has been kicked off and the execution protocol is finished.
`static int`	`GUI_VISIBLE` The state, when GUI of the operator is visible, code 5.
`static int`	`IDLE` An idle state, code 0.
`static int`	`INITIALIZATION_FAILED` The state, if initialization fails, code -1.
`static int`	`INITIALIZED` The state right after initialization, code 1.
`static int`	`SOURCE_UPDATE_FAILED` The state, when the source update of the operator fails, code 6.
`static int`	`SOURCE_UPDATE_SUCCESSFUL` The state, when the user successfully updated the sources of the operator and the validation has been passed, code 7.
`static int`	`SOURCES_UPDATING` The state, when the user updates the sources of the operator and the validator is running again, code 6.
`static int`	`UNDEFINED` An undefined state, set to `Integer.MIN_VALUE`.
`static int`	`VALIDATING_PARAMETERS` The state, when the `IOperatorValidator` has been initiated and the validation result has not yet been received, code 3.
`static int`	`VALIDATION_FAILED` The state, if the validation of parameters and sources failed, code -3.
`static int`	`VALIDATION_PASSED` The state, if the validation of parameters has been successfully completed, code 4.
`static int`	`WORKPACKAGE_CONSTRUCTED` The state right after work package construction using the default parameters and selected sources, code 2.

Constructor Summary

Constructors
Constructor and Description

ExecutionState()

Constructors
Constructor and Description
`ExecutionState()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`stateToString(int state)` Maps a given `ExecutionState` constant to its String representation.

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

- Field Detail
  - UNDEFINED
```
public static final int UNDEFINED
```
    An undefined state, set to Integer.MIN_VALUE.
    This state is used, when no other state is applicable.
    
    See Also:
    
    Constant Field Values
  - IDLE
```
public static final int IDLE
```
    An idle state, code 0.
    The protocol is currently inactive.
    
    See Also:
    
    Constant Field Values
  - INITIALIZED
```
public static final int INITIALIZED
```
    The state right after initialization, code 1.
    All required classes are registered for an execution and new instances have been constructed.
    
    See Also:
    
    Constant Field Values
  - INITIALIZATION_FAILED
```
public static final int INITIALIZATION_FAILED
```
    The state, if initialization fails, code -1.
    Some or all of the required operator classes cannot be instantiated.
    
    See Also:
    
    Constant Field Values
  - WORKPACKAGE_CONSTRUCTED
```
public static final int WORKPACKAGE_CONSTRUCTED
```
    The state right after work package construction using the default parameters and selected sources, code 2.
    A work package for the requested operator is finished.
    
    See Also:
    
    Constant Field Values
  - VALIDATING_PARAMETERS
```
public static final int VALIDATING_PARAMETERS
```
    The state, when the IOperatorValidator has been initiated and the validation result has not yet been received, code 3.
    The call of validate in the IOperatorValidator placed.
    
    See Also:
    
    Constant Field Values
  - VALIDATION_PASSED
```
public static final int VALIDATION_PASSED
```
    The state, if the validation of parameters has been successfully completed, code 4.
    The operator is permitted to be executed on the selected item(s).
    
    See Also:
    
    Constant Field Values
  - VALIDATION_FAILED
```
public static final int VALIDATION_FAILED
```
    The state, if the validation of parameters and sources failed, code -3.
    The operator is not permitted to be executed on the selected item(s).
    
    See Also:
    
    Constant Field Values
  - GUI_VISIBLE
```
public static final int GUI_VISIBLE
```
    The state, when GUI of the operator is visible, code 5.
    The GUI has been constructed and the default values have been set to the custom GUI control elements.
    
    See Also:
    
    Constant Field Values
  - SOURCES_UPDATING
```
public static final int SOURCES_UPDATING
```
    The state, when the user updates the sources of the operator and the validator is running again, code 6.
    The old sources have been replaced by the new ones and the validator checks, if the sources are permitted.
    The parameters remain unchanged.
    
    See Also:
    
    Constant Field Values
  - SOURCE_UPDATE_SUCCESSFUL
```
public static final int SOURCE_UPDATE_SUCCESSFUL
```
    The state, when the user successfully updated the sources of the operator and the validation has been passed, code 7.
    The new sources are set to the GUI of the operator.
    
    See Also:
    
    Constant Field Values
  - SOURCE_UPDATE_FAILED
```
public static final int SOURCE_UPDATE_FAILED
```
    The state, when the source update of the operator fails, code 6.
    The sources are reset to the last known working state.
    
    See Also:
    
    Constant Field Values
  - ERROR
```
public static final int ERROR
```
    The state, when the protocol encountered errors.
    
    See Also:
    
    Constant Field Values
  - FINISHED
```
public static final int FINISHED
```
    The state, when the operator has been kicked off and the execution protocol is finished.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ExecutionState
```
public ExecutionState()
```
- Method Detail
  - stateToString
```
public static String stateToString(int state)
```
    Maps a given ExecutionState constant to its String representation.
    
    Parameters:
    
    state - one of the constant fields in ExecutionState
    
    Returns:
    
    the string representation

Class ExecutionState

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNDEFINED

IDLE

INITIALIZED

INITIALIZATION_FAILED

WORKPACKAGE_CONSTRUCTED

VALIDATING_PARAMETERS

VALIDATION_PASSED

VALIDATION_FAILED

GUI_VISIBLE

SOURCES_UPDATING

SOURCE_UPDATE_SUCCESSFUL

SOURCE_UPDATE_FAILED

ERROR

FINISHED

Constructor Detail

ExecutionState

Method Detail

stateToString