Package org.camunda.bpm.engine.runtime

package org.camunda.bpm.engine.runtime

Classes related to the RuntimeService.

Related Packages

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.

Class	Description
ActivityInstance	An activity instance represents an instance of an activity.
ActivityInstantiationBuilder<T extends ActivityInstantiationBuilder<T>>
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
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<T extends InstantiationBuilder<T>>
Job	Represents one job (timer, message, etc.).
JobQuery	Allows programmatic querying of Jobs.
MessageCorrelationAsyncBuilder	A fluent builder for defining asynchronous message correlation
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
NativeExecutionQuery	Allows querying of Executions via native (SQL) queries
NativeProcessInstanceQuery	Allows querying of ProcessInstances via native (SQL) queries
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.
UpdateProcessInstanceSuspensionStateSelectBuilder	Fluent builder to update the suspension state of process instances.
UpdateProcessInstanceSuspensionStateTenantBuilder	Fluent builder to update the suspension state of process instances.
VariableInstance	A VariableInstance represents a variable in the execution of a process instance.
VariableInstanceQuery
WhitelistingDeserializationTypeValidator	Validate a type before deserialization against a whitelist of allowed types