| Package | Description |
|---|---|
| org.activiti.engine |
Public API of the Flowable version 5 engine.
It is highly recommended that the version 6 engine be used instead of the version 5 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 org.activiti5.engine.runtime.ProcessInstances.TaskService: Exposes operations to manage human (standalone) Tasks,
such as claiming, completing and assigning tasks.IdentityService: Used for managing Users,
org.flowable.idm.api.identity.Groups and the relations between them.ManagementService: Exposes engine administration and maintenance operations,
which have no relation to the runtime exection 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.activiti.engine.delegate.event.impl | |
| org.activiti.engine.impl |
API implementation classes, which shouldn't directly be used by end-users.
|
| org.activiti.engine.impl.bpmn.helper | |
| org.activiti.engine.impl.cmd | |
| org.activiti.engine.impl.event.logger | |
| org.activiti.engine.impl.event.logger.handler | |
| org.flowable.cmmn.api.event | |
| org.flowable.cmmn.engine.impl.event | |
| org.flowable.common.engine.api.delegate.event | |
| org.flowable.common.engine.impl.event | |
| org.flowable.compatibility | |
| org.flowable.crystalball.simulator.delegate.event.impl | |
| org.flowable.engine |
Public API of the Flowable 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 administration and maintenance operations,
which have no relation to the runtime exection 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.flowable.engine.compatibility | |
| org.flowable.engine.delegate.event | |
| org.flowable.engine.delegate.event.impl | |
| org.flowable.engine.impl |
API implementation classes, which shouldn't directly be used by end-users.
|
| org.flowable.engine.impl.bpmn.helper | |
| org.flowable.engine.impl.cmd | |
| org.flowable.engine.impl.event.logger | |
| org.flowable.engine.impl.event.logger.handler | |
| org.flowable.engine.impl.history.async.json.transformer | |
| org.flowable.engine.test.impl.logger | |
| org.flowable.idm.api.event | |
| org.flowable.idm.engine.delegate.event.impl | |
| org.flowable.variable.api.event | |
| org.flowable.variable.service.event.impl |
| Modifier and Type | Method and Description |
|---|---|
void |
RuntimeService.dispatchEvent(FlowableEvent event)
Dispatches the given event to any listeners that are registered.
|
| Modifier and Type | Method and Description |
|---|---|
static FlowableEvent |
ActivitiEventBuilder.createEvent(FlowableEngineEventType type,
String executionId,
String processInstanceId,
String processDefinitionId) |
static FlowableEvent |
ActivitiEventBuilder.createGlobalEvent(FlowableEngineEventType type) |
| Modifier and Type | Method and Description |
|---|---|
void |
RuntimeServiceImpl.dispatchEvent(FlowableEvent event) |
| Modifier and Type | Method and Description |
|---|---|
protected boolean |
BaseDelegateEventListener.isValidEvent(FlowableEvent event) |
void |
ErrorThrowingEventListener.onEvent(FlowableEvent event) |
void |
DelegateExpressionActivitiEventListener.onEvent(FlowableEvent event) |
void |
DelegateActivitiEventListener.onEvent(FlowableEvent event) |
void |
SignalThrowingEventListener.onEvent(FlowableEvent event) |
void |
MessageThrowingEventListener.onEvent(FlowableEvent event) |
| Modifier and Type | Field and Description |
|---|---|
protected FlowableEvent |
DispatchEventCommand.event |
| Constructor and Description |
|---|
DispatchEventCommand(FlowableEvent event) |
| Modifier and Type | Method and Description |
|---|---|
protected EventLoggerEventHandler |
EventLogger.getEventHandler(FlowableEvent event) |
protected EventLoggerEventHandler |
EventLogger.instantiateEventHandler(FlowableEvent event,
Class<? extends EventLoggerEventHandler> eventHandlerClass) |
void |
EventLogger.onEvent(FlowableEvent event) |
| Modifier and Type | Field and Description |
|---|---|
protected FlowableEvent |
AbstractDatabaseEventLoggerEventHandler.event |
| Modifier and Type | Method and Description |
|---|---|
void |
AbstractDatabaseEventLoggerEventHandler.setEvent(FlowableEvent event) |
void |
EventLoggerEventHandler.setEvent(FlowableEvent event) |
| Modifier and Type | Interface and Description |
|---|---|
interface |
FlowableCaseStartedEvent |
| Modifier and Type | Class and Description |
|---|---|
class |
FlowableCaseStartedEventImpl |
| Modifier and Type | Interface and Description |
|---|---|
interface |
FlowableEngineEntityEvent |
interface |
FlowableEngineEvent |
interface |
FlowableEntityEvent
An
FlowableEvent related to a single entity. |
| Modifier and Type | Method and Description |
|---|---|
void |
FlowableEventDispatcher.dispatchEvent(FlowableEvent event,
String engineType)
Dispatches the given event to any listeners that are registered.
|
void |
FlowableEventListener.onEvent(FlowableEvent event)
Called when an event has been fired
|
| Modifier and Type | Class and Description |
|---|---|
class |
FlowableEngineEventImpl
Base class for all
FlowableEngineEvent implementations. |
class |
FlowableEntityEventImpl
Base class for all
FlowableEvent implementations, related to entities. |
class |
FlowableEntityExceptionEventImpl
Base class for all
FlowableEvent implementations, represents an exception occurred, related to an entity. |
class |
FlowableEventImpl
Base class for all
FlowableEvent implementations. |
| Modifier and Type | Field and Description |
|---|---|
protected FlowableEvent |
ExecuteEventListenerTransactionListener.flowableEvent |
| Modifier and Type | Method and Description |
|---|---|
void |
EventDispatchAction.dispatchEvent(CommandContext commandContext,
FlowableEventSupport eventSupport,
FlowableEvent event) |
void |
FlowableEventSupport.dispatchEvent(FlowableEvent event) |
protected void |
FlowableEventSupport.dispatchEvent(FlowableEvent event,
FlowableEventListener listener) |
void |
FlowableEventDispatcherImpl.dispatchEvent(FlowableEvent event,
String engineType) |
protected void |
FlowableEventSupport.dispatchNormalEventListener(FlowableEvent event,
FlowableEventListener listener) |
protected void |
FlowableEventSupport.dispatchTransactionEventListener(FlowableEvent event,
FlowableEventListener listener) |
| Constructor and Description |
|---|
ExecuteEventListenerTransactionListener(FlowableEventListener listener,
FlowableEvent flowableEvent) |
| Modifier and Type | Method and Description |
|---|---|
void |
DefaultFlowable5CompatibilityHandler.throwErrorEvent(FlowableEvent event) |
| Modifier and Type | Field and Description |
|---|---|
protected List<Function<FlowableEvent,SimulationEvent>> |
AbstractRecordFlowableEventListener.transformers |
| Modifier and Type | Method and Description |
|---|---|
SimulationEvent |
ProcessInstanceCreateTransformer.apply(FlowableEvent event) |
SimulationEvent |
DeploymentCreateTransformer.apply(FlowableEvent event) |
SimulationEvent |
UserTaskCompleteTransformer.apply(FlowableEvent event) |
void |
AbstractRecordFlowableEventListener.onEvent(FlowableEvent event) |
protected Collection<SimulationEvent> |
AbstractRecordFlowableEventListener.transform(FlowableEvent event) |
| Constructor and Description |
|---|
AbstractRecordFlowableEventListener(List<Function<FlowableEvent,SimulationEvent>> transformers) |
InMemoryRecordFlowableEventListener(List<Function<FlowableEvent,SimulationEvent>> transformers) |
| Modifier and Type | Method and Description |
|---|---|
void |
RuntimeService.dispatchEvent(FlowableEvent event)
Dispatches the given event to any listeners that are registered.
|
| Modifier and Type | Method and Description |
|---|---|
void |
Flowable5CompatibilityHandler.throwErrorEvent(FlowableEvent event) |
| Modifier and Type | Interface and Description |
|---|---|
interface |
FlowableActivityCancelledEvent
An
FlowableEvent related to cancel event being sent to an activity. |
interface |
FlowableActivityEvent
An
FlowableEvent related to an activity within an execution. |
interface |
FlowableCancelledEvent |
interface |
FlowableConditionalEvent
An
FlowableEvent related to a conditional being sent to an activity. |
interface |
FlowableEntityWithVariablesEvent
An
FlowableEntityEvent related to a single entity. |
interface |
FlowableErrorEvent
An
FlowableEvent related to an error being sent to an activity. |
interface |
FlowableEscalationEvent
An
FlowableEvent related to an escalation being sent to an activity. |
interface |
FlowableJobRescheduledEvent |
interface |
FlowableMessageEvent
An
FlowableEvent related to an message being sent to an activity. |
interface |
FlowableMultiInstanceActivityCancelledEvent
An
FlowableEvent related to cancel event being sent to an activity. |
interface |
FlowableMultiInstanceActivityCompletedEvent |
interface |
FlowableMultiInstanceActivityEvent
A
FlowableEvent related to a multi-instance activity within an execution. |
interface |
FlowableProcessEngineEvent
Event interface for
FlowableEvent implementations related to the process engine,
exposing process engine specific functions. |
interface |
FlowableProcessStartedEvent
An
FlowableEvent related to start event being sent when a process instance is started. |
interface |
FlowableProcessTerminatedEvent
Event extends default
FlowableEntityEvent with the cause of termination |
interface |
FlowableSequenceFlowTakenEvent
An
FlowableEvent that indicates a certain sequence flow has been taken. |
interface |
FlowableSignalEvent
An
FlowableEvent related to a signal being sent to an activity. |
| Modifier and Type | Method and Description |
|---|---|
protected boolean |
BaseEntityEventListener.isValidEvent(FlowableEvent event) |
protected void |
BaseEntityEventListener.onCreate(FlowableEvent event)
Called when an entity create event is received.
|
protected void |
BaseEntityEventListener.onDelete(FlowableEvent event)
Called when an entity delete event is received.
|
protected void |
BaseEntityEventListener.onEntityEvent(FlowableEvent event)
Called when an event is received, which is not a create, an update or delete.
|
void |
AbstractFlowableEngineEventListener.onEvent(FlowableEvent flowableEvent) |
void |
BaseEntityEventListener.onEvent(FlowableEvent event) |
protected void |
BaseEntityEventListener.onInitialized(FlowableEvent event)
Called when an entity initialized event is received.
|
protected void |
BaseEntityEventListener.onUpdate(FlowableEvent event)
Called when an entity update event is received.
|
| Modifier and Type | Method and Description |
|---|---|
static FlowableEvent |
FlowableEventBuilder.createEvent(FlowableEngineEventType type,
String executionId,
String processInstanceId,
String processDefinitionId) |
static FlowableEvent |
FlowableEventBuilder.createGlobalEvent(FlowableEngineEventType type) |
| Modifier and Type | Method and Description |
|---|---|
void |
BpmnModelEventDispatchAction.dispatchEvent(CommandContext commandContext,
FlowableEventSupport eventSupport,
FlowableEvent event) |
protected BpmnModel |
BpmnModelEventDispatchAction.extractBpmnModelFromEvent(FlowableEvent event)
In case no process-context is active, this method attempts to extract a process-definition based on the event.
|
| Modifier and Type | Method and Description |
|---|---|
void |
RuntimeServiceImpl.dispatchEvent(FlowableEvent event) |
| Modifier and Type | Method and Description |
|---|---|
protected boolean |
BaseDelegateEventListener.isValidEvent(FlowableEvent event) |
void |
DelegateFlowableEventListener.onEvent(FlowableEvent event) |
void |
DelegateExpressionFlowableEventListener.onEvent(FlowableEvent event) |
void |
SignalThrowingEventListener.onEvent(FlowableEvent event) |
void |
ErrorThrowingEventListener.onEvent(FlowableEvent event) |
void |
MessageThrowingEventListener.onEvent(FlowableEvent event) |
| Modifier and Type | Field and Description |
|---|---|
protected FlowableEvent |
DispatchEventCommand.event |
| Constructor and Description |
|---|
DispatchEventCommand(FlowableEvent event) |
| Modifier and Type | Method and Description |
|---|---|
protected EventLoggerEventHandler |
EventLogger.getEventHandler(FlowableEvent event) |
protected EventLoggerEventHandler |
EventLogger.instantiateEventHandler(FlowableEvent event,
Class<? extends EventLoggerEventHandler> eventHandlerClass) |
void |
EventLogger.onEvent(FlowableEvent event) |
| Modifier and Type | Field and Description |
|---|---|
protected FlowableEvent |
AbstractDatabaseEventLoggerEventHandler.event |
| Modifier and Type | Method and Description |
|---|---|
void |
EventLoggerEventHandler.setEvent(FlowableEvent event) |
void |
AbstractDatabaseEventLoggerEventHandler.setEvent(FlowableEvent event) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
AbstractHistoryJsonTransformer.dispatchEvent(CommandContext commandContext,
FlowableEvent event) |
| Modifier and Type | Method and Description |
|---|---|
protected ExecutionEntity |
DebugInfoEntityEventListener.getExecutionEntity(FlowableEvent event) |
protected void |
DebugInfoEntityEventListener.onCreate(FlowableEvent event) |
protected void |
DebugInfoEntityEventListener.onDelete(FlowableEvent event) |
| Modifier and Type | Interface and Description |
|---|---|
interface |
FlowableIdmMembershipEvent
An event related to group memberships.
|
| Modifier and Type | Class and Description |
|---|---|
class |
FlowableIdmEntityEventImpl
Base class for all
FlowableIdmEventImpl implementations, related to entities. |
class |
FlowableIdmEventImpl
Base class for all IDM event implementations.
|
class |
FlowableIdmMembershipEventImpl
Implementation of
FlowableIdmMembershipEvent. |
| Modifier and Type | Method and Description |
|---|---|
static FlowableEvent |
FlowableIdmEventBuilder.createGlobalEvent(FlowableIdmEventType type) |
| Modifier and Type | Interface and Description |
|---|---|
interface |
FlowableVariableEvent
An
FlowableEvent related to a single variable. |
| Modifier and Type | Class and Description |
|---|---|
class |
FlowableVariableEventImpl
Implementation of
FlowableVariableEvent. |
Copyright © 2023 Flowable. All rights reserved.