org.activiti.engine.delegate.event.impl

Class ActivitiEventBuilder

java.lang.Object

org.activiti.engine.delegate.event.impl.ActivitiEventBuilder

public class ActivitiEventBuilder
extends Object

Builder class used to create FlowableEvent implementations.

Author:

Frederik Heremans

Constructor Summary

Constructors

Constructor and Description
ActivitiEventBuilder()

Method Summary

Modifier and Type	Method and Description
static FlowableActivityCancelledEvent	createActivityCancelledEvent(String activityId, String activityName, String executionId, String processInstanceId, String processDefinitionId, String activityType, String behaviourClass, Object cause)
static FlowableActivityEvent	createActivityEvent(org.flowable.common.engine.api.delegate.event.FlowableEngineEventType type, String activityId, String activityName, String executionId, String processInstanceId, String processDefinitionId, String activityType, String behaviourClass)
static FlowableCancelledEvent	createCancelledEvent(String executionId, String processInstanceId, String processDefinitionId, Object cause)
static org.flowable.common.engine.api.delegate.event.FlowableEntityEvent	createEntityEvent(org.flowable.common.engine.api.delegate.event.FlowableEngineEventType type, Object entity)
static org.flowable.common.engine.api.delegate.event.FlowableEntityEvent	createEntityEvent(org.flowable.common.engine.api.delegate.event.FlowableEngineEventType type, Object entity, String executionId, String processInstanceId, String processDefinitionId)
static org.flowable.common.engine.api.delegate.event.FlowableEntityEvent	createEntityExceptionEvent(org.flowable.common.engine.api.delegate.event.FlowableEngineEventType type, Object entity, Throwable cause)
static org.flowable.common.engine.api.delegate.event.FlowableEntityEvent	createEntityExceptionEvent(org.flowable.common.engine.api.delegate.event.FlowableEngineEventType type, Object entity, Throwable cause, String executionId, String processInstanceId, String processDefinitionId)
static FlowableEntityWithVariablesEvent	createEntityWithVariablesEvent(org.flowable.common.engine.api.delegate.event.FlowableEngineEventType type, Object entity, Map variables, boolean localScope)
static FlowableErrorEvent	createErrorEvent(org.flowable.common.engine.api.delegate.event.FlowableEngineEventType type, String activityId, String errorCode, String executionId, String processInstanceId, String processDefinitionId)
static org.flowable.common.engine.api.delegate.event.FlowableEvent	createEvent(org.flowable.common.engine.api.delegate.event.FlowableEngineEventType type, String executionId, String processInstanceId, String processDefinitionId)
static org.flowable.common.engine.api.delegate.event.FlowableEvent	createGlobalEvent(org.flowable.common.engine.api.delegate.event.FlowableEngineEventType type)
static org.flowable.idm.api.event.FlowableIdmMembershipEvent	createMembershipEvent(org.flowable.idm.api.event.FlowableIdmEventType type, String groupId, String userId)
static FlowableMessageEvent	createMessageEvent(org.flowable.common.engine.api.delegate.event.FlowableEngineEventType type, String activityId, String messageName, Object payload, String executionId, String processInstanceId, String processDefinitionId)
static FlowableProcessStartedEvent	createProcessStartedEvent(Object entity, Map variables, boolean localScope)
static FlowableSequenceFlowTakenEvent	createSequenceFlowTakenEvent(org.flowable.common.engine.api.delegate.event.FlowableEngineEventType type, String sequenceFlowId, String sourceActivityId, String sourceActivityName, String sourceActivityType, String sourceActivityBehaviorClass, String targetActivityId, String targetActivityName, String targetActivityType, String targetActivityBehaviorClass)
static FlowableSignalEvent	createSignalEvent(org.flowable.common.engine.api.delegate.event.FlowableEngineEventType type, String activityId, String signalName, Object signalData, String executionId, String processInstanceId, String processDefinitionId)
static org.flowable.variable.api.event.FlowableVariableEvent	createVariableEvent(org.flowable.common.engine.api.delegate.event.FlowableEngineEventType type, String variableName, Object variableValue, org.flowable.variable.api.types.VariableType variableType, String taskId, String executionId, String processInstanceId, String processDefinitionId)
protected static void	populateEventWithCurrentContext(ActivitiEventImpl event)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ActivitiEventBuilder

public ActivitiEventBuilder()

Method Detail

createGlobalEvent

public static org.flowable.common.engine.api.delegate.event.FlowableEvent createGlobalEvent(org.flowable.common.engine.api.delegate.event.FlowableEngineEventType type)

Parameters:

type - type of event

Returns:

an FlowableEvent that doesn't have it's execution context-fields filled, as the event is a global event, independent of any running execution.

createEvent

public static org.flowable.common.engine.api.delegate.event.FlowableEvent createEvent(org.flowable.common.engine.api.delegate.event.FlowableEngineEventType type,
                                                                                      String executionId,
                                                                                      String processInstanceId,
                                                                                      String processDefinitionId)

createEntityEvent

public static org.flowable.common.engine.api.delegate.event.FlowableEntityEvent createEntityEvent(org.flowable.common.engine.api.delegate.event.FlowableEngineEventType type,
                                                                                                  Object entity)

Parameters:

type - type of event

entity - the entity this event targets

Returns:

an FlowableEntityEvent. In case an ExecutionContext is active, the execution related event fields will be populated. If not, execution details will be retrieved from the Object if possible.

createProcessStartedEvent

public static FlowableProcessStartedEvent createProcessStartedEvent(Object entity,
                                                                    Map variables,
                                                                    boolean localScope)

Parameters:

entity - the entity this event targets

variables - the variables associated with this entity

Returns:

an FlowableEntityEvent. In case an ExecutionContext is active, the execution related event fields will be populated. If not, execution details will be retrieved from the Object if possible.

createEntityWithVariablesEvent

public static FlowableEntityWithVariablesEvent createEntityWithVariablesEvent(org.flowable.common.engine.api.delegate.event.FlowableEngineEventType type,
                                                                              Object entity,
                                                                              Map variables,
                                                                              boolean localScope)

Parameters:

type - type of event

entity - the entity this event targets

variables - the variables associated with this entity

Returns:

an FlowableEntityEvent. In case an ExecutionContext is active, the execution related event fields will be populated. If not, execution details will be retrieved from the Object if possible.

createSequenceFlowTakenEvent

public static FlowableSequenceFlowTakenEvent createSequenceFlowTakenEvent(org.flowable.common.engine.api.delegate.event.FlowableEngineEventType type,
                                                                          String sequenceFlowId,
                                                                          String sourceActivityId,
                                                                          String sourceActivityName,
                                                                          String sourceActivityType,
                                                                          String sourceActivityBehaviorClass,
                                                                          String targetActivityId,
                                                                          String targetActivityName,
                                                                          String targetActivityType,
                                                                          String targetActivityBehaviorClass)

createEntityEvent

public static org.flowable.common.engine.api.delegate.event.FlowableEntityEvent createEntityEvent(org.flowable.common.engine.api.delegate.event.FlowableEngineEventType type,
                                                                                                  Object entity,
                                                                                                  String executionId,
                                                                                                  String processInstanceId,
                                                                                                  String processDefinitionId)

Parameters:

type - type of event

entity - the entity this event targets

Returns:

an FlowableEntityEvent

createEntityExceptionEvent

public static org.flowable.common.engine.api.delegate.event.FlowableEntityEvent createEntityExceptionEvent(org.flowable.common.engine.api.delegate.event.FlowableEngineEventType type,
                                                                                                           Object entity,
                                                                                                           Throwable cause)

Parameters:

type - type of event

entity - the entity this event targets

cause - the cause of the event

Returns:

an FlowableEntityEvent that is also instance of FlowableExceptionEvent. In case an ExecutionContext is active, the execution related event fields will be populated.

createEntityExceptionEvent

public static org.flowable.common.engine.api.delegate.event.FlowableEntityEvent createEntityExceptionEvent(org.flowable.common.engine.api.delegate.event.FlowableEngineEventType type,
                                                                                                           Object entity,
                                                                                                           Throwable cause,
                                                                                                           String executionId,
                                                                                                           String processInstanceId,
                                                                                                           String processDefinitionId)

Parameters:

type - type of event

entity - the entity this event targets

cause - the cause of the event

Returns:

an FlowableEntityEvent that is also instance of FlowableExceptionEvent.

createActivityEvent

public static FlowableActivityEvent createActivityEvent(org.flowable.common.engine.api.delegate.event.FlowableEngineEventType type,
                                                        String activityId,
                                                        String activityName,
                                                        String executionId,
                                                        String processInstanceId,
                                                        String processDefinitionId,
                                                        String activityType,
                                                        String behaviourClass)

createActivityCancelledEvent

public static FlowableActivityCancelledEvent createActivityCancelledEvent(String activityId,
                                                                          String activityName,
                                                                          String executionId,
                                                                          String processInstanceId,
                                                                          String processDefinitionId,
                                                                          String activityType,
                                                                          String behaviourClass,
                                                                          Object cause)

createCancelledEvent

public static FlowableCancelledEvent createCancelledEvent(String executionId,
                                                          String processInstanceId,
                                                          String processDefinitionId,
                                                          Object cause)

createSignalEvent

public static FlowableSignalEvent createSignalEvent(org.flowable.common.engine.api.delegate.event.FlowableEngineEventType type,
                                                    String activityId,
                                                    String signalName,
                                                    Object signalData,
                                                    String executionId,
                                                    String processInstanceId,
                                                    String processDefinitionId)

createMessageEvent

public static FlowableMessageEvent createMessageEvent(org.flowable.common.engine.api.delegate.event.FlowableEngineEventType type,
                                                      String activityId,
                                                      String messageName,
                                                      Object payload,
                                                      String executionId,
                                                      String processInstanceId,
                                                      String processDefinitionId)

createErrorEvent

public static FlowableErrorEvent createErrorEvent(org.flowable.common.engine.api.delegate.event.FlowableEngineEventType type,
                                                  String activityId,
                                                  String errorCode,
                                                  String executionId,
                                                  String processInstanceId,
                                                  String processDefinitionId)

createVariableEvent

public static org.flowable.variable.api.event.FlowableVariableEvent createVariableEvent(org.flowable.common.engine.api.delegate.event.FlowableEngineEventType type,
                                                                                        String variableName,
                                                                                        Object variableValue,
                                                                                        org.flowable.variable.api.types.VariableType variableType,
                                                                                        String taskId,
                                                                                        String executionId,
                                                                                        String processInstanceId,
                                                                                        String processDefinitionId)

createMembershipEvent

public static org.flowable.idm.api.event.FlowableIdmMembershipEvent createMembershipEvent(org.flowable.idm.api.event.FlowableIdmEventType type,
                                                                                          String groupId,
                                                                                          String userId)

populateEventWithCurrentContext

protected static void populateEventWithCurrentContext(ActivitiEventImpl event)