## Uses of Interface
org.activiti.engine.delegate.event.ActivitiEvent

- Packages that use ActivitiEvent
  Package | Description
  --- | ---
  org.activiti.engine | Public API of the Activiti 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 `Deployment`s `RuntimeService`: For starting and searching `ProcessInstance`s `TaskService`: Exposes operations to manage human (standalone) `Task`s, such as claiming, completing and assigning tasks `IdentityService`: Used for managing `User`s, `Group`s and the relations between them `ManagementService`: Exposes engine admin 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 |
  org.activiti.engine.delegate.event.impl |

- - ### Uses of ActivitiEvent in org.activiti.engine

    Methods in org.activiti.engine with parameters of type ActivitiEvent
    Modifier and Type | Method and Description
    --- | ---
    `void` | RuntimeService.`dispatchEvent(ActivitiEvent event)` Dispatches the given event to any listeners that are registered.

  - ### Uses of ActivitiEvent in org.activiti.engine.delegate.event

    Subinterfaces of ActivitiEvent in org.activiti.engine.delegate.event
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `ActivitiActivityCancelledEvent` An `ActivitiEvent` related to cancel event being sent to an activity.
    `interface` | `ActivitiActivityEvent` An `ActivitiEvent` related to an activity within an execution;
    `interface` | `ActivitiCancelledEvent` An `ActivitiEvent` related to cancel event being sent when activiti object is cancelled.
    `interface` | `ActivitiEntityEvent` An `ActivitiEvent` related to a single entity.
    `interface` | `ActivitiEntityWithVariablesEvent` An `ActivitiEntityEvent` related to a single entity.
    `interface` | `ActivitiErrorEvent` An `ActivitiEvent` related to an error being sent to an activity.
    `interface` | `ActivitiMembershipEvent` An event related to group memberships.
    `interface` | `ActivitiMessageEvent` An `ActivitiEvent` related to an message being sent to an activity.
    `interface` | `ActivitiProcessStartedEvent` An `ActivitiEvent` related to start event being sent when activiti process instance is started.
    `interface` | `ActivitiSequenceFlowTakenEvent` An `ActivitiEvent` that indicates a certain sequence flow has been taken.
    `interface` | `ActivitiSignalEvent` An `ActivitiEvent` related to a signal being sent to an activity.
    `interface` | `ActivitiVariableEvent` An `ActivitiEvent` related to a single variable.

    Methods in org.activiti.engine.delegate.event with parameters of type ActivitiEvent
    Modifier and Type | Method and Description
    --- | ---
    `void` | ActivitiEventDispatcher.`dispatchEvent(ActivitiEvent event)` Dispatches the given event to any listeners that are registered.
    `protected boolean` | BaseEntityEventListener.`isValidEvent(ActivitiEvent event)`
    `protected void` | BaseEntityEventListener.`onCreate(ActivitiEvent event)` Called when an entity create event is received.
    `protected void` | BaseEntityEventListener.`onDelete(ActivitiEvent event)` Called when an entity delete event is received.
    `protected void` | BaseEntityEventListener.`onEntityEvent(ActivitiEvent event)` Called when an event is received, which is not a create, an update or delete.
    `void` | BaseEntityEventListener.`onEvent(ActivitiEvent event)`
    `void` | ActivitiEventListener.`onEvent(ActivitiEvent event)` Called when an event has been fired
    `protected void` | BaseEntityEventListener.`onInitialized(ActivitiEvent event)` Called when an entity initialized event is received.
    `protected void` | BaseEntityEventListener.`onUpdate(ActivitiEvent event)` Called when an entity update event is received.

  - ### Uses of ActivitiEvent in org.activiti.engine.delegate.event.impl

    Classes in org.activiti.engine.delegate.event.impl that implement ActivitiEvent
    Modifier and Type | Class and Description
    --- | ---
    `class` | `ActivitiActivityCancelledEventImpl` An `ActivitiActivityCancelledEvent` implementation.
    `class` | `ActivitiActivityEventImpl` Implementation of an `ActivitiActivityEvent`.
    `class` | `ActivitiEntityEventImpl` Base class for all `ActivitiEvent` implementations, related to entities.
    `class` | `ActivitiEntityExceptionEventImpl` Base class for all `ActivitiEvent` implementations, represents an exception occured, related to an entity.
    `class` | `ActivitiEntityWithVariablesEventImpl` Base class for all `ActivitiEntityEvent` implementations, related to entities with variables.
    `class` | `ActivitiErrorEventImpl` Implementation of an `ActivitiErrorEvent`.
    `class` | `ActivitiEventImpl` Base class for all `ActivitiEvent` implementations.
    `class` | `ActivitiMembershipEventImpl` Implementation of `ActivitiMembershipEvent`.
    `class` | `ActivitiMessageEventImpl` An `ActivitiSignalEvent` implementation.
    `class` | `ActivitiProcessCancelledEventImpl` An `ActivitiCancelledEvent` implementation.
    `class` | `ActivitiProcessStartedEventImpl` An `ActivitiCancelledEvent` implementation.
    `class` | `ActivitiSequenceFlowTakenEventImpl`
    `class` | `ActivitiSignalEventImpl` An `ActivitiSignalEvent` implementation.
    `class` | `ActivitiVariableEventImpl` Implementation of `ActivitiVariableEvent`.

    Methods in org.activiti.engine.delegate.event.impl that return ActivitiEvent
    Modifier and Type | Method and Description
    --- | ---
    `static ActivitiEvent` | ActivitiEventBuilder.`createEvent(ActivitiEventType type, String executionId, String processInstanceId, String processDefinitionId)`
    `static ActivitiEvent` | ActivitiEventBuilder.`createGlobalEvent(ActivitiEventType type)`

    Methods in org.activiti.engine.delegate.event.impl with parameters of type ActivitiEvent
    Modifier and Type | Method and Description
    --- | ---
    `void` | ActivitiEventSupport.`dispatchEvent(ActivitiEvent event)`
    `void` | ActivitiEventDispatcherImpl.`dispatchEvent(ActivitiEvent event)`
    `protected void` | ActivitiEventSupport.`dispatchEvent(ActivitiEvent event, ActivitiEventListener listener)`
    `protected org.activiti.engine.impl.persistence.entity.ProcessDefinitionEntity` | ActivitiEventDispatcherImpl.`extractProcessDefinitionEntityFromEvent(ActivitiEvent event)` In case no process-context is active, this method attempts to extract a process-definition based on the event.

Copyright © 2016 Alfresco. All rights reserved.