Class QueryWorkflowInstances
java.lang.Object
io.nflow.engine.model.ModelObject
io.nflow.engine.workflow.instance.QueryWorkflowInstances
Parameters for workflow instance query.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Builder for workflow instance queries. -
Field Summary
FieldsModifier and TypeFieldDescriptionfinal String
External business key.final String
External identifier.Workflow instance identifiers.final boolean
Setting this to true will make the query return also workflow actions.final boolean
Setting this to true will make the query return also the updated state variables for workflow actions.final boolean
Setting this to true will make the query return also the created child workflow instance IDs.final boolean
Setting this to true will make the query return also the current state variables for the workflow.final Long
The maximum number of actions to be returned for each instance by the query.final Long
The maximum number of instances to be returned by the query.Parent workflow action id.Parent workflow instance id.final boolean
If true, query also the archive tables if not enough results are found from the main tables.Workflow instance states.final String
State variable key.final String
State variable value.Workflow instance statuses.Workflow instance definition type. -
Method Summary
Methods inherited from class io.nflow.engine.model.ModelObject
equals, hashCode, toString
-
Field Details
-
ids
Workflow instance identifiers. -
types
Workflow instance definition type. -
parentWorkflowId
Parent workflow instance id. -
parentActionId
Parent workflow action id. -
states
Workflow instance states. -
statuses
Workflow instance statuses. -
businessKey
External business key. -
externalId
External identifier. -
stateVariableKey
State variable key. -
stateVariableValue
State variable value. -
includeActions
public final boolean includeActionsSetting this to true will make the query return also workflow actions. -
includeCurrentStateVariables
public final boolean includeCurrentStateVariablesSetting this to true will make the query return also the current state variables for the workflow. -
includeActionStateVariables
public final boolean includeActionStateVariablesSetting this to true will make the query return also the updated state variables for workflow actions. -
includeChildWorkflows
public final boolean includeChildWorkflowsSetting this to true will make the query return also the created child workflow instance IDs. -
maxResults
The maximum number of instances to be returned by the query. If null, uses default value configured for the nFlow engine. The maximum value may also be limited by nFlow engine configuration. -
maxActions
The maximum number of actions to be returned for each instance by the query. If null, uses default value configured for the nFlow engine. The maximum value may also be limited by nFlow engine configuration. -
queryArchive
public final boolean queryArchiveIf true, query also the archive tables if not enough results are found from the main tables.
-