All Classes and Interfaces
Class
Description
Custom form types should extend this abstract class.
Represents one execution of an activity in the currently running process.
Programmatic querying for
ActivityInstances.Invoker responsible for submitting tasks to the task executor.
Any type of content that is be associated with a task or with a process instance.
Flowable Authentication context that can be implemented in different ways to hold and store the current authentication information.
Base event listener that can be used when implementing an
FlowableEventListener to get notified when an entity is created, updated, deleted or if another entity-related event occurs.Callback interface to be notified of execution events like starting a process instance, ending an activity instance or taking a transition.
Allows programmatic querying of
Jobs.Created by Pardo David on 5/12/2016.
Service which provides access to batch entities.
Special exception that can be used to throw a BPMN Error from
JavaDelegates and expressions.Allows to hook into the parsing of one or more elements during the parsing of a BPMN 2.0 process.
A callback type is set on an entity that needs to 'call back' to some other entity,
typically when the entity is completed or deleted.
[Experimental]
An interface for listener implementations that get notified when the state of a case instance changes.
A builder API to create an event subscription to start an event-based case instance whenever an event with a very specific
combination of correlation values occurs.
A builder API to delete a manually created case start event subscription which was created and registered using the
CmmnRuntimeService.createCaseInstanceStartEventSubscriptionBuilder() builder API.A builder API to modify a manually created case start event subscription which was created and registered using the
CmmnRuntimeService.createCaseInstanceStartEventSubscriptionBuilder() builder API.The case reactivation builder is used to create all the necessary and optional information for an archived / finished case to be reactivated.
Helper for changing the state of a process instance.
Helper for changing the state of a case instance.
Helper for changing the tenant id from active and historic instances.
Container interface to return the result of a change in a tenant id operation
An object structure representing a channel definition
Allows programmatic querying of
ChannelDefinitions.Builder for creating new deployments, similar to the bpmn deployment builder.
Allows programmatic querying of
CmmnDeployments.Service to manager case instance migrations.
User comments that form discussions around tasks.
An annotation that can be used on test classes or as a meta annotation to use a custom configuration resource for the
FlowableExtension.Can be used to pass a custom properties
HashMap to a TransactionDependentExecutionListener or to a TransactionDependentTaskListenerAllows programmatic querying of
Jobs.Used for
FlowElement currently not supported by the DynamicBpmnService and elements who are not parsed.Execution used in
JavaDelegates and ExecutionListeners.Class that provides helper operations for use in the
JavaDelegate, ActivityBehavior, ExecutionListener and TaskListener interfaces.Defines the different states of delegation that a task can be in.
Describes methods for Queries that can perform delete operations.
Represents a deployment that is already present in the process repository.
Annotation for a test method to create and delete a deployment around a test method.
Builder for creating new deployments.
An annotation that can be used on test methods, lifecycle method to inject the id of the deployment deployed via
Deployment.Allows programmatic querying of
Deployments.Stores waypoints of a diagram edge.
Stores the position of a waypoint of a diagram edge.
Represents a diagram node.
Stores a two-dimensional graph layout.
Stores position and dimensions of a diagram node.
An object structure representing an executable DMN decision
Allows programmatic querying of
DmnDecisions.Service for executing DMN decisions
Represents a deployment that is already present in the dmn repository.
Builder for creating new deployments.
Allows programmatic querying of
DmnDeployments.An object structure representing the execution of a decision
Allows programmatic querying of
DmnHistoricDecisionExecutions.Service providing access to the history of decision executions.
Service for admin and maintenance operations on the dmn engine.
Service providing access to the repository of decision(services) and deployments.
Service providing access to the repository of process definitions and deployments.
An API to manipulate running CMMN based case instances or plan items.
Pojo class who can be used to check information between
DynamicBpmnService.getProcessDefinitionInfo(String) and BpmnModel.Represents a deployment that is already present in the engine repository.
Interface describing a listener that gets notified when certain event occurs, related to the engine lifecycle it is attached to.
Exposes twitter-like feeds for tasks and process instances.
Exposes twitter-like feeds for tasks and process instances.
An object structure representing an event definition
Allows programmatic querying of
EventDefinitions.Represents a deployment that is already present in the event repository.
Builder for creating new deployments.
Allows programmatic querying of
EventDeployments.Represents a runtime event (either received or sent).
Element for defining an event listener to hook in to the global event-mechanism.
Central registry for events that are received through external channels through a
InboundEventChannelAdapter
and then passed through as a event registry event.Service providing access to the repository of forms.
Represent an event subscription for a process definition or a process instance.
Allows programmatic querying of
EventSubscriptions.Helper for execution a decision.
Represent a 'path of execution' in a process instance.
Callback interface to be notified of execution events like starting a process instance, ending an activity instance or taking a transition.
Allows programmatic querying of
Executions.Iterates over an
ExecutionTree using breadth-first searchAllows programmatic querying of External Worker
Jobs.An
FlowableEvent related to cancel event being sent to an activity.An
FlowableActivityCancelledEvent implementation.An
FlowableEvent related to an activity within an execution.Implementation of an
FlowableActivityEvent.The interface for a case ended event, which might be a case completed or case terminated event.
An event representing a CMMN case stage being ended either manually through termination or with an exit sentry or by completing it.
An event representing a CMMN case stage being started.
Runtime exception indicating the requested class was not found or an error occurred while loading the class.
An
FlowableEvent related to a conditional being sent to an activity.An
FlowableConditionalEvent implementation.This interface exposes methods needed to manipulate the agenda implementation.
Enumeration containing all possible types of
FlowableEvents.An
FlowableEvent related to a single entity.Base class for all
FlowableEvent implementations, related to entities.Base class for all
FlowableEvent implementations, represents an exception occurred, related to an entity.An
FlowableEntityEvent related to a single entity.Base class for all
FlowableEngineEntityEvent implementations, related to entities with variables.An
FlowableEvent related to an error being sent to an activity.Implementation of an
FlowableErrorEvent.An
FlowableEvent related to an escalation being sent to an activity.An
FlowableEscalationEvent implementation.Describes an event that occurred in the Flowable Engine which is dispatched to external listeners, if any.
Builder class used to create
FlowableEvent implementations.Dispatcher which allows for adding and removing
FlowableEventListener s to the Flowable Engine as well as dispatching FlowableEvent to all the listeners registered.Describes a class that listens for
FlowableEvents dispatched by the engine.Enumeration containing all possible types of
FlowableEvents.Runtime exception that is the superclass of all Flowable exceptions.
Indicates the
FlowableEvent also contains information about a Throwable that occurred, triggering the event.JUnit Jupiter extension for the Flowable ProcessEngine and services initialization.
Interface for pluggable functions that can be used in the EL expressions
Convenience class which always uses the
AsyncTaskInvoker to execute the async data.An exception indicating that an illegal argument has been supplied in an Flowable API-call, an illegal value was configured in the engine's configuration or an illegal value has been supplied or an
illegal value is used in a process-definition.
An exception indicating that an API call could not be executed due to data being in the wrong state.
An
FlowableEvent related to an message being sent to an activity.An
FlowableSignalEvent implementation.An
FlowableEvent related to cancel event being sent to an activity.An
FlowableMultiInstanceActivityCancelledEvent implementation.Implementation of an
FlowableMultiInstanceActivityCompletedEvent.A
FlowableEvent related to a multi-instance activity within an execution.Implementation of an
FlowableMultiInstanceActivityEvent.An exception indicating that the object that is required or actioned on does not exist.
Exception that is thrown when an optimistic locking occurs in the datastore caused by concurrent access of the same data entry.
Convenience class which always uses the
AsyncTaskInvoker to execute the async data.An
FlowableCancelledEvent implementation.Event interface for
FlowableEvent implementations related to the process engine,
exposing process engine specific functions.An
FlowableEvent related to start event being sent when a process instance is started.An
FlowableCancelledEvent implementation.Event extends default
FlowableEntityEvent with the cause of terminationAn
FlowableProcessTerminatedEvent implementation.Deprecated, for removal: This API element is subject to removal in a future version.
An
FlowableEvent that indicates a certain sequence flow has been taken.An
FlowableEvent related to a signal being sent to an activity.An
FlowableSignalEvent implementation.This exception is thrown when you try to claim a task that is already claimed by someone else.
Convenience for annotation that activates the
FlowableExtension JUnit Jupiter annotation.Deprecated, for removal: This API element is subject to removal in a future version.
Use JUnit Jupiter with
FlowableTest insteadA Helper for the Flowable
FlowableExtension that can be used within the JUnit Jupiter context store
and users can use it in the tests for easy modifying of the ProcessEngine time and easy access for waiting on the job executor.An
FlowableEvent related to a single variable.Implementation of
FlowableVariableEvent.Exception that is thrown when the Flowable engine discovers a mismatch between the database schema version and the engine version.
Contains all information for displaying a form and serves as base interface for
StartFormData and TaskFormDataRepresents a single property on a form.
Access to form data and rendered forms for starting new process instances and completing tasks.
Used to indicate the type on a
FormProperty.Convenience class that should be used when a Java delegation in a BPMN 2.0 process is required (for example, to call custom business logic).
Interface indicating an element has execution-listeners
Interface for accessing Element attributes.
Interface for accessing Element attributes.
A scriptable element supporting the type="script" implementation type.
An element supporting form field validation
An element supporting form field validation
Represents one execution of an activity and it's stored permanent for statistics, audit and other business intelligence purposes.
Programmatic querying for
HistoricActivityInstances.Base class for all kinds of information that is related to either a
HistoricProcessInstance or a HistoricActivityInstance.Programmatic querying for
HistoricDetails.A single field that was submitted in either a start form or a task form.
Historic counterpart of
IdentityLink that represents the current state if any runtime link.A single execution of a whole process definition that is stored permanently.
Allows programmatic querying of
HistoricProcessInstances.Represents a historic task instance (waiting, finished or deleted) that is stored permanent for statistics, audit and other business intelligence purposes.
Allows programmatic querying for
HistoricTaskInstances.Interface to create and add task log entry
Allows programmatic querying of
HistoricTaskLogEntrys;A single process variable containing the last value when its process instance has finished.
Programmatic querying for
HistoricVariableInstances.Update of a process variable.
Represents one history job
Allows programmatic querying of
HistoryJobs.Service exposing information about ongoing and past process instances.
An identity link is used to associate a task with a certain identity.
Contains constants for all types of identity links that can be used to involve a user or group with a certain object.
Service to manage
Users and Groups.A builder to create a
InboundChannelModel instance,
which represents a channel from the 'outside world' to receive events.Builder for the filtering out inbound events.
Builder for the filtering out inbound JSON events.
Builder for the filtering out inbound XML events.
Builder for the 'key detection' part of the
InboundChannelModel.Builder for the 'key detection' part of the
InboundChannelModel, specifically for JSON events.Builder for the 'key detection' part of the
InboundChannelModel, specifically for XML events.Builder for the 'payload extraction' part of the
InboundChannelModel.Builder for the 'payload extraction' part of the
InboundChannelModel.Builder for the 'payload extraction' part of the
InboundChannelModel.Builder for the 'processing pipeline' part of the
InboundChannelModel.Builder for the 'tenant ID detection' part of the
InboundChannelModel.Builder for the 'tenant ID detection' part of the
InboundChannelModel, specifically for JSON eventsBuilder for the 'tenant ID detection' part of the
InboundChannelModel, specifically for XML eventsBuilder to create an
InboundEventChannelAdapter using JMS.Builder to create an
InboundEventChannelAdapter using Kafka.Builder to create an
InboundEventChannelAdapter using RabbitMQ.This interface must be implemented by a custom filtering bean to hook into the default inbound event processing
pipeline in order to have a very effective way to filter out events which should not be processed any further and
thus preventing expensive processing time like DB lookups and the full consumer invocation.
A builder API to create new, dynamically injected plan items into an existing, running stage instance.
Convenience class that should be used when a Java delegation in a BPMN 2.0 process is required (for example, to call custom business logic).
Represents one job (timer, async job, etc.).
Interface for a job that can be directly executed (e.g an async job or a history job).
This exception is thrown when you try to execute a job that is not found (may be due to cancelActiviti="true" for instance)..
Allows programmatic querying of
Jobs.Constants and functions for MDC (Mapped Diagnostic Context) logging
Service for admin and maintenance operations on the process engine.
A
FlowablePlanItemFutureJavaDelegate which has a ReadOnlyDelegatePlanItemInstance as input and Map output data.This is a bridge resolver, making available any objects registered through
Mocks.register(java.lang.String, java.lang.Object) inside scripts supported by process execution.Registry for mock objects.
Represents a model that is stored in the model repository.
Allows programmatic querying of
Models.Allows querying of
ActivityInstanceQuerys via native (SQL) queriesAllows querying of
Deployments via native (SQL) queriesAllows querying of
DmnDeployments via native (SQL) queriesAllows querying of
Executions via native (SQL) queriesAllows querying of
HistoricActivityInstanceQuerys via native (SQL) queriesAllows querying of
HistoricDetails via native (SQL) queriesAllows querying of
HistoricTaskInstanceQuerys via native (SQL) queriesAllows querying of
HistoricTaskLogEntrys via native (SQL) queriesAllows querying of
HistoricVariableInstances via native (SQL) queriesAllows querying of
Models via native (SQL) queriesAllows querying of
ProcessDefinitions via native (SQL) queriesAllows querying of
ProcessInstances via native (SQL) queriesDescribes basic methods for doing native queries
Allows querying of
Tasks via native (SQL) queriesAllows querying of
VariableInstances via native (SQL) queriesA builder to create an
OutboundChannelModel instance.Builder for the 'event processing' pipeline which gets invoked before sending out the event.
Builder to create an
OutboundEventChannelAdapter using JMS.Builder to create an
OutboundEventChannelAdapter using Kafka.Builder to create an
OutboundEventChannelAdapter using RabbitMQ.Even though plan fragments don't have a runtime behavior, they still need to be stored in the
CmmnModel,
as they are needed when exporting the XML.Convenience class to be used when needing to execute custom logic for a plan item by delegating to a Java class.
[Experimental]
An interface for listener implementations that get notified when the state of a plan item instance changes.
Allows to query for
PlanItemInstances.A builder that allows to execute a transition for a plan item instance from one state to another,
optionally passing variables before the transition.
Convenience class to be used when needing to execute custom logic for a plan item by delegating to a Java class.
An interface that can be used to aggregate multiple variables into a single one based on an aggregation definition.
An object structure representing an executable process composed of activities and transitions.
Allows programmatic querying of
ProcessDefinitions.Provides access to all the services that expose the BPM and workflow operations.
Configuration information from which a process engine can be build.
Interface describing a listener that gets notified when certain event occurs, related to the process-engine lifecycle it is attached to.
Helper for initializing and closing process engines in server environments.
Represents one execution of a
ProcessDefinition.Helper for starting new ProcessInstance.
A trail of data for a given process instance.
Allows to fetch the
ProcessInstanceHistoryLog for a process instance.Allows programmatic querying of
ProcessInstances.A builder API to create an event subscription to start an event-based process instance whenever an event with a very specific
combination of correlation values occurs.
A builder API to delete a manually created process start event subscription which was created and registered using the
builder API.
invalid reference
RuntimeService#createProcessStartEventSubscriptionBuilder()A builder API to modify a manually created process start event subscription which was created and registered using the
builder API.
invalid reference
RuntimeService#createProcessStartEventSubscriptionBuilder()Service to manager process instance migrations.
Created by Pardo David on 5/12/2016.
Created by Pardo David on 5/12/2016.
Describes basic methods for querying.
Describes a property that can be used in a Query.
The reactivation listener is a very specific user event listener available on a historic case instance in order to reactivate it again.
The reactivation rule describes how a plan item is reactivated during phase two of case reactivation.
Service providing access to the repository of process definitions and deployments.
The Resource class is used to specify resources that can be referenced by Activities.
Contains relevant information for script evaluation.
Contains relevant information for script evaluation.
Created by Pardo David on 5/12/2016.
Specific
FormData for starting a new process instance.Allows programmatic querying of
Jobs.Structure containing meta data (column names, column types, etc.) about a certain database table.
Data structure used for retrieving database table content.
Allows programmatic querying of
TablePages.Represents one task for a human user.
Wraps
TaskInfo to the builder.This builder is an alternative to using any of the complete methods on the TaskService.
Specific
FormData for completing a task.Interface containing shared methods between the
TaskQuery and the HistoricTaskInstanceQuery.This is a helper class to help you work with the
TaskInfoQuery, without having to care about the awful generics.Here for backwards compatibility, prefer use the
TaskListener.Allows programmatic querying of
Tasks;Service which provides access to
Task and form related operations.Flowable Tenant context that can be implemented in different ways to hold and store the tenant information.
Allows programmatic querying of
Jobs.Callback interface to be notified of transaction events.
Created by Pardo David on 5/12/2016.
Common interface for regular and historic variable entities.
An interface that can be used to aggregate multiple variables into a single one based on an aggregation definition.
Generic variable class that can be reused for V6 and V5 engine.
Programmatic querying for
VariableInstances.Interface for class that acts as a scope for variables: i.e. the implementation can be used to set and get variables.
Interface describing a container for all available
VariableTypes of variables.
FlowableTestinstead