java.lang.Object
- io.nflow.engine.model.ModelObject
- - io.nflow.engine.workflow.instance.WorkflowInstance

public class WorkflowInstance
extends ModelObject

An instance of a workflow.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`WorkflowInstance.Builder`	Builder for workflow instance.
`static class`	`WorkflowInstance.WorkflowInstanceStatus`	Describes the status for workflow instance.

Field Summary

Fields
Modifier and Type	Field	Description
`List<WorkflowInstanceAction>`	`actions`	The list of actions.
`String`	`businessKey`	Business key.
`Map<Long,List<Long>>`	`childWorkflows`	Child workflow instance IDs created by this workflow instance, grouped by instance action ID.
`org.joda.time.DateTime`	`created`	The workflow instance creation time.
`String`	`executorGroup`	The name of the executor group for this workflow instance.
`Integer`	`executorId`	The id of executor that is currently processing this workflow.
`String`	`externalId`	External identifier of the workflow instance.
`Long`	`id`	The workflow instance identifier.
`boolean`	`isArchived`	True if this instance is archived.
`org.joda.time.DateTime`	`modified`	The last modification time of the workflow instance.
`org.joda.time.DateTime`	`nextActivation`	The next activation time for the workflow instance.
`Map<String,String>`	`originalStateVariables`	The state variable values before executor started processing the state.
`Long`	`parentActionId`	The id of the workflow action that created this sub workflow.
`Long`	`parentWorkflowId`	The id of the workflow that created this sub workflow.
`Short`	`priority`	The priority of the workflow instance.
`int`	`retries`	Number of retry attempts of the current state.
`Optional<Integer>`	`signal`	The signal raised for this workflow instance.
`org.joda.time.DateTime`	`started`	Time when workflow processing was started, that is, time when processing of first action started.
`String`	`state`	The name of the current state.
`String`	`stateText`	The description of the last action executed by the workflow.
`Map<String,String>`	`stateVariables`	The state variables.
`WorkflowInstance.WorkflowInstanceStatus`	`status`	The current status of the workflow instance.
`String`	`type`	The type of the workflow definition.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Map<String,String>`	`getChangedStateVariables()`	Return the state variables that have been added or modified during state processing.
`String`	`getStateVariable(String name)`
`<T> T`	`getStateVariable(String name, Class<T> valueType)`
`<T> T`	`getStateVariable(String name, Class<T> valueType, T defaultValue)`
`String`	`getStateVariable(String name, String defaultValue)`

Methods inherited from class io.nflow.engine.model.ModelObject
equals, hashCode, toString

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

- Field Detail
  - id
```
public final Long id
```
    The workflow instance identifier.
  - executorId
```
public final Integer executorId
```
    The id of executor that is currently processing this workflow. May be null.
  - parentWorkflowId
```
public final Long parentWorkflowId
```
    The id of the workflow that created this sub workflow. Is null for root workflows.
  - parentActionId
```
public final Long parentActionId
```
    The id of the workflow action that created this sub workflow. Is null for root workflows.
  - status
```
public final WorkflowInstance.WorkflowInstanceStatus status
```
    The current status of the workflow instance.
  - type
```
public final String type
```
    The type of the workflow definition.
  - priority
```
public final Short priority
```
    The priority of the workflow instance. When an executor chooses from many available scheduled workflow instances it primarily (unfairly) schedules the workflow instance with the larger priority value, and for workflows with the same priority, the one scheduled first. Priority defaults to 0 and can also be negative.
  - businessKey
```
public final String businessKey
```
    Business key.
  - externalId
```
public final String externalId
```
    External identifier of the workflow instance. Must be unique within the same executor group.
  - state
```
public final String state
```
    The name of the current state.
  - stateText
```
public final String stateText
```
    The description of the last action executed by the workflow.
  - nextActivation
```
public final org.joda.time.DateTime nextActivation
```
    The next activation time for the workflow instance.
  - stateVariables
```
public final Map<String,String> stateVariables
```
    The state variables. Uses the variable name as the key and serialized variable value as value.
  - originalStateVariables
```
public final Map<String,String> originalStateVariables
```
    The state variable values before executor started processing the state.
  - actions
```
public final List<WorkflowInstanceAction> actions
```
    The list of actions.
  - retries
```
public final int retries
```
    Number of retry attempts of the current state. Zero when the state is executed for the first time.
  - created
```
public final org.joda.time.DateTime created
```
    The workflow instance creation time.
  - modified
```
public final org.joda.time.DateTime modified
```
    The last modification time of the workflow instance.
  - started
```
public final org.joda.time.DateTime started
```
    Time when workflow processing was started, that is, time when processing of first action started.
  - executorGroup
```
public final String executorGroup
```
    The name of the executor group for this workflow instance.
  - signal
```
public final Optional<Integer> signal
```
    The signal raised for this workflow instance.
  - isArchived
```
public final boolean isArchived
```
    True if this instance is archived. Archived instances are read-only, no modifications are allowed to them.
  - childWorkflows
```
public Map<Long,List<Long>> childWorkflows
```
    Child workflow instance IDs created by this workflow instance, grouped by instance action ID.
- Method Detail
  - getChangedStateVariables
```
public Map<String,String> getChangedStateVariables()
```
    Return the state variables that have been added or modified during state processing.
    
    Returns:
    
    New and modified state variables.
  - getStateVariable
```
public String getStateVariable(String name)
```
  - getStateVariable
```
public <T> T getStateVariable(String name,
                              Class<T> valueType)
```
  - getStateVariable
```
public <T> T getStateVariable(String name,
                              Class<T> valueType,
                              T defaultValue)
```
  - getStateVariable
```
public String getStateVariable(String name,
                               String defaultValue)
```

Class WorkflowInstance

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class io.nflow.engine.model.ModelObject

Methods inherited from class java.lang.Object

Field Detail

id

executorId

parentWorkflowId

parentActionId

status

type

priority

businessKey

externalId

state

stateText

nextActivation

stateVariables

originalStateVariables

actions

retries

created

modified

started

executorGroup

signal

isArchived

childWorkflows

Method Detail

getChangedStateVariables

getStateVariable

getStateVariable

getStateVariable

getStateVariable