Uses of Package
org.camunda.bpm.engine.runtime

Packages that use org.camunda.bpm.engine.runtime

Package	Description
org.camunda.bpm.engine	Public API of the Camunda Platform engine. Typical usage of the API starts by the creation of a ProcessEngineConfiguration (typically based on a configuration file), from which a ProcessEngine can be obtained. Through the services obtained from such a ProcessEngine, BPM and workflow operation can be executed: RepositoryService: Manages Deployments RuntimeService: For starting and searching ProcessInstances TaskService: Exposes operations to manage human (standalone) Tasks, such as claiming, completing and assigning tasks IdentityService: Used for managing Users, Groups and the relations between them ManagementService: Exposes engine admin and maintenance operations, which have no relation to the runtime execution of business processes HistoryService: Exposes information about ongoing and past process instances. FormService: Access to form data and rendered forms for starting new process instances and completing tasks.
org.camunda.bpm.engine.cdi
org.camunda.bpm.engine.cdi.impl.annotation
org.camunda.bpm.engine.cdi.impl.context
org.camunda.bpm.engine.delegate	Interfaces used to include Java code in a process as the behavior of an activity or as a listener to process events with JavaDelegates.
org.camunda.bpm.engine.externaltask
org.camunda.bpm.engine.impl	API implementation classes, which shouldn't directly be used by end-users.
org.camunda.bpm.engine.impl.cfg
org.camunda.bpm.engine.impl.cfg.auth
org.camunda.bpm.engine.impl.cfg.multitenancy
org.camunda.bpm.engine.impl.cmd
org.camunda.bpm.engine.impl.cmd.batch
org.camunda.bpm.engine.impl.cmd.batch.variables
org.camunda.bpm.engine.impl.cmmn
org.camunda.bpm.engine.impl.cmmn.cmd
org.camunda.bpm.engine.impl.cmmn.entity.runtime
org.camunda.bpm.engine.impl.core.variable.event
org.camunda.bpm.engine.impl.history.producer
org.camunda.bpm.engine.impl.incident
org.camunda.bpm.engine.impl.migration
org.camunda.bpm.engine.impl.migration.instance
org.camunda.bpm.engine.impl.migration.instance.parser
org.camunda.bpm.engine.impl.persistence.entity
org.camunda.bpm.engine.impl.pvm.runtime
org.camunda.bpm.engine.impl.runtime
org.camunda.bpm.engine.impl.test
org.camunda.bpm.engine.impl.util
org.camunda.bpm.engine.impl.variable.listener
org.camunda.bpm.engine.migration
org.camunda.bpm.engine.rest.dto
org.camunda.bpm.engine.rest.dto.message
org.camunda.bpm.engine.rest.dto.runtime
org.camunda.bpm.engine.rest.dto.runtime.modification
org.camunda.bpm.engine.rest.hal
org.camunda.bpm.engine.rest.impl
org.camunda.bpm.engine.rest.sub.impl
org.camunda.bpm.engine.rest.sub.repository.impl
org.camunda.bpm.engine.rest.sub.runtime.impl
org.camunda.bpm.engine.runtime	Classes related to the RuntimeService.
org.camunda.bpm.qa.upgrade

Classes in org.camunda.bpm.engine.runtime used by org.camunda.bpm.engine

Class and Description
ActivityInstance An activity instance represents an instance of an activity.
CaseExecutionCommandBuilder A fluent builder for defining a command to execute for a case execution.
CaseExecutionQuery
CaseInstance
CaseInstanceBuilder A fluent builder to create a new case instance.
CaseInstanceQuery
ConditionEvaluationBuilder A fluent builder for defining conditional start event correlation
DeserializationTypeValidator Validate a type before deserialization
EventSubscriptionQuery Allows querying of event subscriptions.
ExecutionQuery Allows programmatic querying of Executions.
Incident An Incident represents a failure in the execution of a process instance.
IncidentQuery
Job Represents one job (timer, message, etc.).
JobQuery Allows programmatic querying of Jobs.
MessageCorrelationBuilder A fluent builder for defining message correlation
ModificationBuilder
NativeExecutionQuery Allows querying of Executions via native (SQL) queries
NativeProcessInstanceQuery Allows querying of ProcessInstances via native (SQL) queries
ProcessInstance Represents one execution of a ProcessDefinition.
ProcessInstanceModificationBuilder A fluent builder to specify a modification of process instance state in terms of cancellation of activity instances and instantiations of activities and sequence flows.
ProcessInstanceQuery Allows programmatic querying of ProcessInstances.
ProcessInstantiationBuilder
RestartProcessInstanceBuilder
SignalEventReceivedBuilder Fluent builder to notify the process engine that a signal event has been received.
UpdateProcessInstanceSuspensionStateSelectBuilder Fluent builder to update the suspension state of process instances.
VariableInstanceQuery

Classes in org.camunda.bpm.engine.runtime used by org.camunda.bpm.engine.cdi

Class and Description
Execution Represent a 'path of execution' in a process instance.
ProcessInstance Represents one execution of a ProcessDefinition.

Classes in org.camunda.bpm.engine.runtime used by org.camunda.bpm.engine.cdi.impl.annotation

Class and Description
ProcessInstance Represents one execution of a ProcessDefinition.

Classes in org.camunda.bpm.engine.runtime used by org.camunda.bpm.engine.cdi.impl.context

Class and Description
Execution Represent a 'path of execution' in a process instance.

Classes in org.camunda.bpm.engine.runtime used by org.camunda.bpm.engine.delegate

Class and Description
Incident An Incident represents a failure in the execution of a process instance.
VariableInstance A VariableInstance represents a variable in the execution of a process instance.

Classes in org.camunda.bpm.engine.runtime used by org.camunda.bpm.engine.externaltask

Class and Description
ProcessInstanceQuery Allows programmatic querying of ProcessInstances.

Classes in org.camunda.bpm.engine.runtime used by org.camunda.bpm.engine.impl

Class and Description
ActivityInstance An activity instance represents an instance of an activity.
ActivityInstantiationBuilder
ConditionEvaluationBuilder A fluent builder for defining conditional start event correlation
EventSubscription A message event subscription exists, if an Execution waits for an event like a message.
EventSubscriptionQuery Allows querying of event subscriptions.
Execution Represent a 'path of execution' in a process instance.
ExecutionQuery Allows programmatic querying of Executions.
Incident An Incident represents a failure in the execution of a process instance.
IncidentQuery
InstantiationBuilder
Job Represents one job (timer, message, etc.).
JobQuery Allows programmatic querying of Jobs.
MessageCorrelationBuilder A fluent builder for defining message correlation
MessageCorrelationResult The result of a message correlation.
MessageCorrelationResultWithVariables * The result of a message correlation containing the process variables
ModificationBuilder
NativeExecutionQuery Allows querying of Executions via native (SQL) queries
NativeProcessInstanceQuery Allows querying of ProcessInstances via native (SQL) queries
ProcessInstance Represents one execution of a ProcessDefinition.
ProcessInstanceModificationBuilder A fluent builder to specify a modification of process instance state in terms of cancellation of activity instances and instantiations of activities and sequence flows.
ProcessInstanceModificationInstantiationBuilder
ProcessInstanceQuery Allows programmatic querying of ProcessInstances.
ProcessInstanceWithVariables Represents a process instance with the corresponding latest variables.
ProcessInstantiationBuilder
RestartProcessInstanceBuilder
SignalEventReceivedBuilder Fluent builder to notify the process engine that a signal event has been received.
UpdateProcessInstancesRequest
UpdateProcessInstancesSuspensionStateBuilder
UpdateProcessInstanceSuspensionStateBuilder Fluent builder to update the suspension state of process instances.
UpdateProcessInstanceSuspensionStateSelectBuilder Fluent builder to update the suspension state of process instances.
VariableInstance A VariableInstance represents a variable in the execution of a process instance.
VariableInstanceQuery

Classes in org.camunda.bpm.engine.runtime used by org.camunda.bpm.engine.impl.cfg

Class and Description
CaseExecution Represent a planned item in a case instance.

Classes in org.camunda.bpm.engine.runtime used by org.camunda.bpm.engine.impl.cfg.auth

Class and Description
CaseExecution Represent a planned item in a case instance.
ProcessInstance Represents one execution of a ProcessDefinition.

Classes in org.camunda.bpm.engine.runtime used by org.camunda.bpm.engine.impl.cfg.multitenancy

Class and Description
CaseExecution Represent a planned item in a case instance.

Classes in org.camunda.bpm.engine.runtime used by org.camunda.bpm.engine.impl.cmd

Class and Description
ActivityInstance An activity instance represents an instance of an activity.
Incident An Incident represents a failure in the execution of a process instance.
Job Represents one job (timer, message, etc.).
JobQuery Allows programmatic querying of Jobs.
ProcessInstance Represents one execution of a ProcessDefinition.
ProcessInstanceQuery Allows programmatic querying of ProcessInstances.
ProcessInstanceWithVariables Represents a process instance with the corresponding latest variables.
TransitionInstance A transition instance represents an execution token that has just completed a transition (sequence flow in BPMN) or is about to take an outgoing transition.

Classes in org.camunda.bpm.engine.runtime used by org.camunda.bpm.engine.impl.cmd.batch

Class and Description
ProcessInstanceQuery Allows programmatic querying of ProcessInstances.

Classes in org.camunda.bpm.engine.runtime used by org.camunda.bpm.engine.impl.cmd.batch.variables

Class and Description
ProcessInstanceQuery Allows programmatic querying of ProcessInstances.

Classes in org.camunda.bpm.engine.runtime used by org.camunda.bpm.engine.impl.cmmn

Class and Description
CaseExecutionCommandBuilder A fluent builder for defining a command to execute for a case execution.
CaseExecutionQuery
CaseInstance
CaseInstanceBuilder A fluent builder to create a new case instance.
CaseInstanceQuery

Classes in org.camunda.bpm.engine.runtime used by org.camunda.bpm.engine.impl.cmmn.cmd

Class and Description
CaseInstance

Classes in org.camunda.bpm.engine.runtime used by org.camunda.bpm.engine.impl.cmmn.entity.runtime

Class and Description
CaseExecution Represent a planned item in a case instance.
CaseExecutionQuery
CaseInstance
CaseInstanceQuery

Classes in org.camunda.bpm.engine.runtime used by org.camunda.bpm.engine.impl.core.variable.event

Class and Description
VariableInstance A VariableInstance represents a variable in the execution of a process instance.

Classes in org.camunda.bpm.engine.runtime used by org.camunda.bpm.engine.impl.history.producer

Class and Description
Incident An Incident represents a failure in the execution of a process instance.
Job Represents one job (timer, message, etc.).

Classes in org.camunda.bpm.engine.runtime used by org.camunda.bpm.engine.impl.incident

Class and Description
Incident An Incident represents a failure in the execution of a process instance.

Classes in org.camunda.bpm.engine.runtime used by org.camunda.bpm.engine.impl.migration

Class and Description
ProcessInstanceQuery Allows programmatic querying of ProcessInstances.

Classes in org.camunda.bpm.engine.runtime used by org.camunda.bpm.engine.impl.migration.instance

Class and Description
ActivityInstance An activity instance represents an instance of an activity.
TransitionInstance A transition instance represents an execution token that has just completed a transition (sequence flow in BPMN) or is about to take an outgoing transition.

Classes in org.camunda.bpm.engine.runtime used by org.camunda.bpm.engine.impl.migration.instance.parser

Class and Description
ActivityInstance An activity instance represents an instance of an activity.
TransitionInstance A transition instance represents an execution token that has just completed a transition (sequence flow in BPMN) or is about to take an outgoing transition.

Classes in org.camunda.bpm.engine.runtime used by org.camunda.bpm.engine.impl.persistence.entity

Class and Description
ActivityInstance An activity instance represents an instance of an activity.
EventSubscription A message event subscription exists, if an Execution waits for an event like a message.
Execution Represent a 'path of execution' in a process instance.
Incident An Incident represents a failure in the execution of a process instance.
Job Represents one job (timer, message, etc.).
ProcessElementInstance A ProcessElementInstance is an instance of a process construct such as an Activity (see ActivityInstance) or a transition (see TransitionInstance).
ProcessInstance Represents one execution of a ProcessDefinition.
ProcessInstanceWithVariables Represents a process instance with the corresponding latest variables.
TransitionInstance A transition instance represents an execution token that has just completed a transition (sequence flow in BPMN) or is about to take an outgoing transition.
VariableInstance A VariableInstance represents a variable in the execution of a process instance.

Classes in org.camunda.bpm.engine.runtime used by org.camunda.bpm.engine.impl.pvm.runtime

Class and Description
Incident An Incident represents a failure in the execution of a process instance.

Classes in org.camunda.bpm.engine.runtime used by org.camunda.bpm.engine.impl.runtime

Class and Description
DeserializationTypeValidator Validate a type before deserialization
Execution Represent a 'path of execution' in a process instance.
MessageCorrelationResult The result of a message correlation.
MessageCorrelationResultType The message correlation result type indicates which type of message correlation result is returned after a message correlation.
MessageCorrelationResultWithVariables * The result of a message correlation containing the process variables
ProcessInstance Represents one execution of a ProcessDefinition.
ProcessInstanceQuery Allows programmatic querying of ProcessInstances.
UpdateProcessInstancesRequest
UpdateProcessInstancesSuspensionStateBuilder
UpdateProcessInstanceSuspensionStateBuilder Fluent builder to update the suspension state of process instances.
UpdateProcessInstanceSuspensionStateSelectBuilder Fluent builder to update the suspension state of process instances.
UpdateProcessInstanceSuspensionStateTenantBuilder Fluent builder to update the suspension state of process instances.
WhitelistingDeserializationTypeValidator Validate a type before deserialization against a whitelist of allowed types

Classes in org.camunda.bpm.engine.runtime used by org.camunda.bpm.engine.impl.test

Class and Description
ActivityInstance An activity instance represents an instance of an activity.

Classes in org.camunda.bpm.engine.runtime used by org.camunda.bpm.engine.impl.util

Class and Description
ProcessElementInstance A ProcessElementInstance is an instance of a process construct such as an Activity (see ActivityInstance) or a transition (see TransitionInstance).

Classes in org.camunda.bpm.engine.runtime used by org.camunda.bpm.engine.impl.variable.listener

Class and Description
VariableInstance A VariableInstance represents a variable in the execution of a process instance.

Classes in org.camunda.bpm.engine.runtime used by org.camunda.bpm.engine.migration

Class and Description
ProcessInstanceQuery Allows programmatic querying of ProcessInstances.

Classes in org.camunda.bpm.engine.runtime used by org.camunda.bpm.engine.rest.dto

Class and Description
ModificationBuilder

Classes in org.camunda.bpm.engine.runtime used by org.camunda.bpm.engine.rest.dto.message

Class and Description
MessageCorrelationResult The result of a message correlation.
MessageCorrelationResultType The message correlation result type indicates which type of message correlation result is returned after a message correlation.
MessageCorrelationResultWithVariables * The result of a message correlation containing the process variables

Classes in org.camunda.bpm.engine.runtime used by org.camunda.bpm.engine.rest.dto.runtime

Class and Description
ActivityInstance An activity instance represents an instance of an activity.
CaseExecution Represent a planned item in a case instance.
CaseExecutionQuery
CaseInstance
CaseInstanceQuery
EventSubscription A message event subscription exists, if an Execution waits for an event like a message.
EventSubscriptionQuery Allows querying of event subscriptions.
Execution Represent a 'path of execution' in a process instance.
ExecutionQuery Allows programmatic querying of Executions.
Incident An Incident represents a failure in the execution of a process instance.
IncidentQuery
Job Represents one job (timer, message, etc.).
JobQuery Allows programmatic querying of Jobs.
ProcessInstance Represents one execution of a ProcessDefinition.
ProcessInstanceQuery Allows programmatic querying of ProcessInstances.
ProcessInstanceWithVariables Represents a process instance with the corresponding latest variables.
RestartProcessInstanceBuilder
TransitionInstance A transition instance represents an execution token that has just completed a transition (sequence flow in BPMN) or is about to take an outgoing transition.
UpdateProcessInstancesSuspensionStateBuilder
UpdateProcessInstanceSuspensionStateBuilder Fluent builder to update the suspension state of process instances.
VariableInstance A VariableInstance represents a variable in the execution of a process instance.
VariableInstanceQuery

Classes in org.camunda.bpm.engine.runtime used by org.camunda.bpm.engine.rest.dto.runtime.modification

Class and Description
ActivityInstantiationBuilder
InstantiationBuilder
ProcessInstanceModificationBuilder A fluent builder to specify a modification of process instance state in terms of cancellation of activity instances and instantiations of activities and sequence flows.

Classes in org.camunda.bpm.engine.runtime used by org.camunda.bpm.engine.rest.hal

Class and Description
VariableInstance A VariableInstance represents a variable in the execution of a process instance.

Classes in org.camunda.bpm.engine.runtime used by org.camunda.bpm.engine.rest.impl

Class and Description
ConditionEvaluationBuilder A fluent builder for defining conditional start event correlation
MessageCorrelationBuilder A fluent builder for defining message correlation
SignalEventReceivedBuilder Fluent builder to notify the process engine that a signal event has been received.

Classes in org.camunda.bpm.engine.runtime used by org.camunda.bpm.engine.rest.sub.impl

Class and Description
DeserializationTypeValidator Validate a type before deserialization

Classes in org.camunda.bpm.engine.runtime used by org.camunda.bpm.engine.rest.sub.repository.impl

Class and Description
ProcessInstanceWithVariables Represents a process instance with the corresponding latest variables.

Classes in org.camunda.bpm.engine.runtime used by org.camunda.bpm.engine.rest.sub.runtime.impl

Class and Description
CaseExecutionCommandBuilder A fluent builder for defining a command to execute for a case execution.
VariableInstance A VariableInstance represents a variable in the execution of a process instance.
VariableInstanceQuery

Classes in org.camunda.bpm.engine.runtime used by org.camunda.bpm.engine.runtime

Class and Description
ActivityInstance An activity instance represents an instance of an activity.
ActivityInstantiationBuilder
CaseExecution Represent a planned item in a case instance.
CaseExecutionCommandBuilder A fluent builder for defining a command to execute for a case execution.
CaseExecutionQuery
CaseInstance
CaseInstanceBuilder A fluent builder to create a new case instance.
CaseInstanceQuery
ConditionEvaluationBuilder A fluent builder for defining conditional start event correlation
DeserializationTypeValidator Validate a type before deserialization
EventSubscriptionQuery Allows querying of event subscriptions.
Execution Represent a 'path of execution' in a process instance.
ExecutionQuery Allows programmatic querying of Executions.
Incident An Incident represents a failure in the execution of a process instance.
IncidentQuery
InstantiationBuilder
JobQuery Allows programmatic querying of Jobs.
MessageCorrelationBuilder A fluent builder for defining message correlation
MessageCorrelationResult The result of a message correlation.
MessageCorrelationResultType The message correlation result type indicates which type of message correlation result is returned after a message correlation.
MessageCorrelationResultWithVariables * The result of a message correlation containing the process variables
ModificationBuilder
ProcessElementInstance A ProcessElementInstance is an instance of a process construct such as an Activity (see ActivityInstance) or a transition (see TransitionInstance).
ProcessInstance Represents one execution of a ProcessDefinition.
ProcessInstanceModificationBuilder A fluent builder to specify a modification of process instance state in terms of cancellation of activity instances and instantiations of activities and sequence flows.
ProcessInstanceModificationInstantiationBuilder
ProcessInstanceQuery Allows programmatic querying of ProcessInstances.
ProcessInstanceWithVariables Represents a process instance with the corresponding latest variables.
ProcessInstantiationBuilder
RestartProcessInstanceBuilder
SignalEventReceivedBuilder Fluent builder to notify the process engine that a signal event has been received.
TransitionInstance A transition instance represents an execution token that has just completed a transition (sequence flow in BPMN) or is about to take an outgoing transition.
UpdateProcessInstancesRequest
UpdateProcessInstancesSuspensionStateBuilder
UpdateProcessInstanceSuspensionStateBuilder Fluent builder to update the suspension state of process instances.
UpdateProcessInstanceSuspensionStateTenantBuilder Fluent builder to update the suspension state of process instances.
VariableInstanceQuery

Classes in org.camunda.bpm.engine.runtime used by org.camunda.bpm.qa.upgrade

Class and Description
CaseExecutionQuery
CaseInstance
CaseInstanceQuery
ExecutionQuery Allows programmatic querying of Executions.
JobQuery Allows programmatic querying of Jobs.
MessageCorrelationBuilder A fluent builder for defining message correlation
ProcessInstance Represents one execution of a ProcessDefinition.
ProcessInstanceQuery Allows programmatic querying of ProcessInstances.