Uses of Package
org.camunda.bpm.engine.runtime
Package
Description
Public API of the Camunda Platform engine.
Typical usage of the API starts by the creation of a
Through the services obtained from such a
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 Deployment
sRuntimeService
:
For starting and searching ProcessInstance
sTaskService
:
Exposes operations to manage human (standalone) Task
s,
such as claiming, completing and assigning tasksIdentityService
:
Used for managing User
s,
Group
s and the relations between themManagementService
:
Exposes engine admin and maintenance operations,
which have no relation to the runtime execution of business processesHistoryService
:
Exposes information about ongoing and past process instances.FormService
:
Access to form data and rendered forms for starting new process instances and completing tasks.Interfaces used to include Java code in a process as the behavior of an activity
or as a listener to process events with
JavaDelegate
s.API implementation classes, which shouldn't directly be used by end-users.
Classes related to the
ManagementService
.Classes related to the
RuntimeService
.-
ClassDescriptionAn activity instance represents an instance of an activity.A fluent builder for defining a command to execute for a case execution.A fluent builder to create a new case instance.A fluent builder for defining conditional start event correlationValidate a type before deserializationAllows querying of event subscriptions.Allows programmatic querying of
Execution
s.AnIncident
represents a failure in the execution of a process instance.Represents one job (timer, message, etc.).Allows programmatic querying ofJob
s.A fluent builder for defining asynchronous message correlationA fluent builder for defining message correlationAllows querying ofExecution
s via native (SQL) queriesAllows querying ofProcessInstance
s via native (SQL) queriesRepresents one execution of aProcessDefinition
.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.Allows programmatic querying ofProcessInstance
s.Fluent builder to notify the process engine that a signal event has been received.Fluent builder to update the suspension state of process instances. -
ClassDescriptionRepresent a 'path of execution' in a process instance.Represents one execution of a
ProcessDefinition
. -
-
-
ClassDescriptionAn
Incident
represents a failure in the execution of a process instance.AVariableInstance
represents a variable in the execution of a process instance. -
-
ClassDescriptionAn activity instance represents an instance of an activity.A fluent builder for defining conditional start event correlationA message event subscription exists, if an
Execution
waits for an event like a message.Allows querying of event subscriptions.Represent a 'path of execution' in a process instance.Allows programmatic querying ofExecution
s.AnIncident
represents a failure in the execution of a process instance.Represents one job (timer, message, etc.).Allows programmatic querying ofJob
s.A fluent builder for defining asynchronous message correlationA fluent builder for defining message correlationThe result of a message correlation.* The result of amessage correlation
containing the process variablesAllows querying ofExecution
s via native (SQL) queriesAllows querying ofProcessInstance
s via native (SQL) queriesRepresents one execution of aProcessDefinition
.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.Allows programmatic querying ofProcessInstance
s.Represents a process instance with the corresponding latest variables.Fluent builder to notify the process engine that a signal event has been received.Fluent builder to update the suspension state of process instances.Fluent builder to update the suspension state of process instances.AVariableInstance
represents a variable in the execution of a process instance. -
-
-
ClassDescriptionRepresent a planned item in a case instance.Represents one execution of a
ProcessDefinition
. -
-
ClassDescriptionAn activity instance represents an instance of an activity.An
Incident
represents a failure in the execution of a process instance.Represents one job (timer, message, etc.).Allows programmatic querying ofJob
s.Represents one execution of aProcessDefinition
.Allows programmatic querying ofProcessInstance
s.Represents a process instance with the corresponding latest variables.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. -
-
-
ClassDescriptionA fluent builder for defining a command to execute for a case execution.A fluent builder to create a new case instance.
-
-
ClassDescriptionRepresent a planned item in a case instance.
-
-
-
-
ClassDescriptionAllows programmatic querying of
Job
s.Allows programmatic querying ofProcessInstance
s. -
-
ClassDescriptionAn activity instance represents an instance of an activity.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.
-
ClassDescriptionAn activity instance represents an instance of an activity.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.
-
ClassDescriptionAn activity instance represents an instance of an activity.A message event subscription exists, if an
Execution
waits for an event like a message.Represent a 'path of execution' in a process instance.AnIncident
represents a failure in the execution of a process instance.Represents one job (timer, message, etc.).A ProcessElementInstance is an instance of a process construct such as an Activity (seeActivityInstance
) or a transition (seeTransitionInstance
).Represents one execution of aProcessDefinition
.Represents a process instance with the corresponding latest variables.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.AVariableInstance
represents a variable in the execution of a process instance. -
-
ClassDescriptionValidate a type before deserializationRepresent a 'path of execution' in a process instance.The result of a message correlation.The message correlation result type indicates which type of message correlation result is returned after a message correlation.* The result of a
message correlation
containing the process variablesRepresents one execution of aProcessDefinition
.Allows programmatic querying ofProcessInstance
s.Fluent builder to update the suspension state of process instances.Fluent builder to update the suspension state of process instances.Fluent builder to update the suspension state of process instances.Validate a type before deserialization against a whitelist of allowed types -
-
ClassDescriptionA ProcessElementInstance is an instance of a process construct such as an Activity (see
ActivityInstance
) or a transition (seeTransitionInstance
). -
-
ClassDescriptionAllows programmatic querying of
Job
s.Allows programmatic querying ofProcessInstance
s. -
-
-
ClassDescriptionThe result of a message correlation.The message correlation result type indicates which type of message correlation result is returned after a message correlation.* The result of a
message correlation
containing the process variables -
ClassDescriptionAn activity instance represents an instance of an activity.Represent a planned item in a case instance.A message event subscription exists, if an
Execution
waits for an event like a message.Allows querying of event subscriptions.Represent a 'path of execution' in a process instance.Allows programmatic querying ofExecution
s.AnIncident
represents a failure in the execution of a process instance.Represents one job (timer, message, etc.).Allows programmatic querying ofJob
s.Represents one execution of aProcessDefinition
.Allows programmatic querying ofProcessInstance
s.Represents a process instance with the corresponding latest variables.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.Fluent builder to update the suspension state of process instances.AVariableInstance
represents a variable in the execution of a process instance. -
ClassDescriptionA fluent builder to specify a modification of process instance state in terms of cancellation of activity instances and instantiations of activities and sequence flows.
-
-
ClassDescriptionA fluent builder for defining conditional start event correlationA fluent builder for defining message correlationFluent builder to notify the process engine that a signal event has been received.
-
-
ClassDescriptionRepresents a process instance with the corresponding latest variables.
-
ClassDescriptionA fluent builder for defining a command to execute for a case execution.A
VariableInstance
represents a variable in the execution of a process instance. -
ClassDescriptionAn activity instance represents an instance of an activity.Represent a planned item in a case instance.A fluent builder for defining a command to execute for a case execution.A fluent builder to create a new case instance.A fluent builder for defining conditional start event correlationValidate a type before deserializationAllows querying of event subscriptions.Represent a 'path of execution' in a process instance.Allows programmatic querying of
Execution
s.AnIncident
represents a failure in the execution of a process instance.Allows programmatic querying ofJob
s.A fluent builder for defining asynchronous message correlationA fluent builder for defining message correlationThe result of a message correlation.The message correlation result type indicates which type of message correlation result is returned after a message correlation.* The result of amessage correlation
containing the process variablesA ProcessElementInstance is an instance of a process construct such as an Activity (seeActivityInstance
) or a transition (seeTransitionInstance
).Represents one execution of aProcessDefinition
.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.Allows programmatic querying ofProcessInstance
s.Represents a process instance with the corresponding latest variables.Fluent builder to notify the process engine that a signal event has been received.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.Fluent builder to update the suspension state of process instances.Fluent builder to update the suspension state of process instances. -
ClassDescriptionAn activity instance represents an instance of an activity.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.
-
ClassDescriptionAllows programmatic querying of
Execution
s.Represents one job (timer, message, etc.).Allows programmatic querying ofJob
s.Represents one execution of aProcessDefinition
.Allows programmatic querying ofProcessInstance
s. -
ClassDescriptionRepresent a planned item in a case instance.
-
ClassDescriptionAllows programmatic querying of
Execution
s.Allows programmatic querying ofJob
s.A fluent builder for defining message correlationRepresents one execution of aProcessDefinition
.Allows programmatic querying ofProcessInstance
s.