ModelInstanceState (LSPS 3.3 SDK)

java.lang.Object
- java.lang.Enum<ModelInstanceState>
- - com.whitestein.lsps.engine.dto.ModelInstanceState

All Implemented Interfaces:

Serializable, Comparable<ModelInstanceState>
```
public enum ModelInstanceState
extends Enum<ModelInstanceState>
```
State of the model instance life-cycle.

Author:

bhl

Enum Constant Summary

Enum Constants
Enum Constant and Description
`CREATED` Model instance created but execution of model not started.
`FINISHED` Model instance finished
`MODEL_UPDATE_ABORTED` Model update aborted.
`MODEL_UPDATE_POSTPROCESSING` Model update postprocessing phase.
`MODEL_UPDATE_PREPROCESSED` Model update preprocessed phase.
`MODEL_UPDATE_PREPROCESSING` Model update preprocessing phase.
`MODEL_UPDATE_TRANSFORMED` Model update transformed phase.
`MODEL_UPDATE_UPDATED` Model update finished.
`RUNNING` Model instance running.
`SUSPENDED` Model instance suspended.

Field Summary

Fields
Modifier and Type	Field and Description
`static Set<ModelInstanceState>`	`INVOKABLE_STATES` The set of invokable states.
`static Set<ModelInstanceState>`	`MODEL_UPDATE_ABORTABLE_STATES` The set of model update states which can be aborted.
`static Set<ModelInstanceState>`	`MODEL_UPDATE_STATES` The set of model update states.
`static Set<ModelInstanceState>`	`MODEL_UPDATEABLE` The set of model instance states which allow model update to be performed.
`static Set<ModelInstanceState>`	`RESTARTABLE_STATES` The set of restartable states.
`static Set<ModelInstanceState>`	`RESUMABLE_STATES` The set of resumable states.
`static Set<ModelInstanceState>`	`RUNNING_STATES` The set of running states.
`static Set<ModelInstanceState>`	`SUSPENDABLE_STATES` The set of suspendable states.
`static Set<ModelInstanceState>`	`SUSPENDED_STATES` The set of suspended states.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canAbortModelUpdate()` Returns true if a model instance in this state is performing a model update and can be aborted.
`static boolean`	`canFinish(ModelInstanceState state)` Returns true if model can be finished.
`static boolean`	`canFinishAll(Set<ModelInstanceState> states)` Returns true if models in all input states models can be finished.
`boolean`	`canResume()` Returns true if a model instance in this state can be resumed.
`boolean`	`canSuspend()` Returns true if a model instance in this state can be suspended.
`boolean`	`isFinished()` Returns true if this a finished state.
`boolean`	`isModelUpdate()` Returns true if a model instance in this state is performing a model update.
`boolean`	`isRunning()` Returns true if a model instance in this state is running.
`boolean`	`isSuspended()` Returns true if a model instance in this state is suspended.
`static ModelInstanceState`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static ModelInstanceState[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

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

- Enum Constant Detail
  - CREATED
```
public static final ModelInstanceState CREATED
```
    Model instance created but execution of model not started.
  - RUNNING
```
public static final ModelInstanceState RUNNING
```
    Model instance running.
  - SUSPENDED
```
public static final ModelInstanceState SUSPENDED
```
    Model instance suspended.
  - FINISHED
```
public static final ModelInstanceState FINISHED
```
    Model instance finished
  - MODEL_UPDATE_PREPROCESSING
```
public static final ModelInstanceState MODEL_UPDATE_PREPROCESSING
```
    Model update preprocessing phase.
  - MODEL_UPDATE_PREPROCESSED
```
public static final ModelInstanceState MODEL_UPDATE_PREPROCESSED
```
    Model update preprocessed phase.
  - MODEL_UPDATE_TRANSFORMED
```
public static final ModelInstanceState MODEL_UPDATE_TRANSFORMED
```
    Model update transformed phase.
  - MODEL_UPDATE_POSTPROCESSING
```
public static final ModelInstanceState MODEL_UPDATE_POSTPROCESSING
```
    Model update postprocessing phase.
  - MODEL_UPDATE_UPDATED
```
public static final ModelInstanceState MODEL_UPDATE_UPDATED
```
    Model update finished.
  - MODEL_UPDATE_ABORTED
```
public static final ModelInstanceState MODEL_UPDATE_ABORTED
```
    Model update aborted.
- Field Detail
  - SUSPENDED_STATES
```
public static final Set<ModelInstanceState> SUSPENDED_STATES
```
    The set of suspended states.
  - RUNNING_STATES
```
public static final Set<ModelInstanceState> RUNNING_STATES
```
    The set of running states.
  - SUSPENDABLE_STATES
```
public static final Set<ModelInstanceState> SUSPENDABLE_STATES
```
    The set of suspendable states.
  - RESUMABLE_STATES
```
public static final Set<ModelInstanceState> RESUMABLE_STATES
```
    The set of resumable states.
  - INVOKABLE_STATES
```
public static final Set<ModelInstanceState> INVOKABLE_STATES
```
    The set of invokable states.
  - RESTARTABLE_STATES
```
public static final Set<ModelInstanceState> RESTARTABLE_STATES
```
    The set of restartable states.
  - MODEL_UPDATE_STATES
```
public static final Set<ModelInstanceState> MODEL_UPDATE_STATES
```
    The set of model update states.
  - MODEL_UPDATE_ABORTABLE_STATES
```
public static final Set<ModelInstanceState> MODEL_UPDATE_ABORTABLE_STATES
```
    The set of model update states which can be aborted.
  - MODEL_UPDATEABLE
```
public static final Set<ModelInstanceState> MODEL_UPDATEABLE
```
    The set of model instance states which allow model update to be performed.
- Method Detail
  - values
```
public static ModelInstanceState[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (ModelInstanceState c : ModelInstanceState.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ModelInstanceState valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - isSuspended
```
public boolean isSuspended()
```
    Returns true if a model instance in this state is suspended.
    
    Returns:
    
    true if a model instance in this state is suspended
  - isRunning
```
public boolean isRunning()
```
    Returns true if a model instance in this state is running.
    
    Returns:
    
    true if a model instance in this state is running
  - isFinished
```
public boolean isFinished()
```
    Returns true if this a finished state.
    
    Returns:
    
    true if this a finished state
  - canResume
```
public boolean canResume()
```
    Returns true if a model instance in this state can be resumed.
    
    Returns:
    
    true if a model instance in this state can be resumed
  - canSuspend
```
public boolean canSuspend()
```
    Returns true if a model instance in this state can be suspended.
    
    Returns:
    
    true if a model instance in this state can be suspended
  - canAbortModelUpdate
```
public boolean canAbortModelUpdate()
```
    Returns true if a model instance in this state is performing a model update and can be aborted.
    
    Returns:
    
    true if a model instance in this state is performing a model update and can be aborted
  - isModelUpdate
```
public boolean isModelUpdate()
```
    Returns true if a model instance in this state is performing a model update.
    
    Returns:
    
    true if a model instance in this state is performing a model update
  - canFinishAll
```
public static boolean canFinishAll(Set<ModelInstanceState> states)
```
    Returns true if models in all input states models can be finished.
    
    Parameters:
    
    states -
    
    Returns:
    
    whether finish button should be enabled
  - canFinish
```
public static boolean canFinish(ModelInstanceState state)
```
    Returns true if model can be finished.
    
    Parameters:
    
    state -
    
    Returns:
    
    whether model in state can be finished

Enum ModelInstanceState

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

CREATED

RUNNING

SUSPENDED

FINISHED

MODEL_UPDATE_PREPROCESSING

MODEL_UPDATE_PREPROCESSED

MODEL_UPDATE_TRANSFORMED

MODEL_UPDATE_POSTPROCESSING

MODEL_UPDATE_UPDATED

MODEL_UPDATE_ABORTED

Field Detail

SUSPENDED_STATES

RUNNING_STATES

SUSPENDABLE_STATES

RESUMABLE_STATES

INVOKABLE_STATES

RESTARTABLE_STATES

MODEL_UPDATE_STATES

MODEL_UPDATE_ABORTABLE_STATES

MODEL_UPDATEABLE

Method Detail

values

valueOf

isSuspended

isRunning

isFinished

canResume

canSuspend

canAbortModelUpdate

isModelUpdate

canFinishAll

canFinish