Package io.nflow.engine.workflow.instance

Class QueryWorkflowInstances

java.lang.Object
io.nflow.engine.model.ModelObject
io.nflow.engine.workflow.instance.QueryWorkflowInstances
public class QueryWorkflowInstances extends ModelObject
Parameters for workflow instance query.

  • Field Details

    • ids

      public final List<Long> ids
      Workflow instance identifiers.

    • types

      public final List<String> types
      Workflow instance definition type.

    • parentWorkflowId

      public Long parentWorkflowId
      Parent workflow instance id.

    • parentActionId

      public Long parentActionId
      Parent workflow action id.

    • states

      public final List<String> states
      Workflow instance states.

    • statuses

      public final List<WorkflowInstance.WorkflowInstanceStatus> statuses
      Workflow instance statuses.

    • businessKey

      public final String businessKey
      External business key.

    • externalId

      public final String externalId
      External identifier.

    • stateVariableKey

      public final String stateVariableKey
      State variable key.

    • stateVariableValue

      public final String stateVariableValue
      State variable value.

    • includeActions

      public final boolean includeActions
      Setting this to true will make the query return also workflow actions.

    • includeCurrentStateVariables

      public final boolean includeCurrentStateVariables
      Setting this to true will make the query return also the current state variables for the workflow.

    • includeActionStateVariables

      public final boolean includeActionStateVariables
      Setting this to true will make the query return also the updated state variables for workflow actions.

    • includeChildWorkflows

      public final boolean includeChildWorkflows
      Setting this to true will make the query return also the created child workflow instance IDs.

    • maxResults

      public final Long 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

      public final Long 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 queryArchive
      If true, query also the archive tables if not enough results are found from the main tables.