Package org.flowable.engine.impl.runtime

Class ProcessInstanceStartEventSubscriptionModificationBuilderImpl

java.lang.Object

org.flowable.engine.impl.runtime.ProcessInstanceStartEventSubscriptionModificationBuilderImpl

All Implemented Interfaces:

ProcessInstanceStartEventSubscriptionModificationBuilder

public class ProcessInstanceStartEventSubscriptionModificationBuilderImpl
extends Object
implements ProcessInstanceStartEventSubscriptionModificationBuilder

The implementation for a process start event subscription modification builder.

Author:

Micha Kiener

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<String,Object>	correlationParameterValues
protected String	newProcessDefinitionId
protected String	processDefinitionId
protected final RuntimeServiceImpl	runtimeService
protected String	tenantId

Constructor Summary

Constructors

Constructor	Description
ProcessInstanceStartEventSubscriptionModificationBuilderImpl(RuntimeServiceImpl runtimeService)

Method Summary

Modifier and Type	Method	Description
ProcessInstanceStartEventSubscriptionModificationBuilder	addCorrelationParameterValue(String parameterName, Object parameterValue)	Adds a specific correlation parameter value for the subscription to be modified.
ProcessInstanceStartEventSubscriptionModificationBuilder	addCorrelationParameterValues(Map<String,Object> parameters)	Registers a list of correlation parameter values for the subscription(s) to be modified.
protected void	checkValidInformation()
Map<String,Object>	getCorrelationParameterValues()
String	getNewProcessDefinitionId()
String	getProcessDefinitionId()
String	getTenantId()
boolean	hasCorrelationParameterValues()
boolean	hasNewProcessDefinitionId()
void	migrateToLatestProcessDefinition()	Migrate all the matching event subscriptions to the latest process definition, which should be done if you want to manually upgrade the subscriptions to the latest version of the process definition.
void	migrateToProcessDefinition(String processDefinitionId)	Migrate all matching event subscriptions to the specific process definition.
ProcessInstanceStartEventSubscriptionModificationBuilder	processDefinitionId(String processDefinitionId)	Set the process definition using its specific id the manually created subscription is based on.
ProcessInstanceStartEventSubscriptionModificationBuilder	tenantId(String tenantId)	Set the tenant id in case you are running in a multi tenant environment and the event model needs to be retrieved from a specific tenant.

Methods inherited from class java.lang.Object

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

Field Details

runtimeService

protected final RuntimeServiceImpl runtimeService

processDefinitionId

protected String processDefinitionId

newProcessDefinitionId

protected String newProcessDefinitionId

tenantId

protected String tenantId

correlationParameterValues

protected final Map<String,Object> correlationParameterValues

Constructor Details

ProcessInstanceStartEventSubscriptionModificationBuilderImpl

public ProcessInstanceStartEventSubscriptionModificationBuilderImpl(RuntimeServiceImpl runtimeService)

Method Details

processDefinitionId

public ProcessInstanceStartEventSubscriptionModificationBuilder processDefinitionId(String processDefinitionId)

Description copied from interface: ProcessInstanceStartEventSubscriptionModificationBuilder

Set the process definition using its specific id the manually created subscription is based on. This is mandatory and must be provided.

Specified by:

processDefinitionId in interface ProcessInstanceStartEventSubscriptionModificationBuilder

Parameters:

processDefinitionId - the id of the process definition the subscription is based on (an exact version of it)

Returns:

the builder to be used for method chaining

tenantId

public ProcessInstanceStartEventSubscriptionModificationBuilder tenantId(String tenantId)

Description copied from interface: ProcessInstanceStartEventSubscriptionModificationBuilder

Set the tenant id in case you are running in a multi tenant environment and the event model needs to be retrieved from a specific tenant.

Specified by:

tenantId in interface ProcessInstanceStartEventSubscriptionModificationBuilder

Parameters:

tenantId - the id of the tenant the subscription is created for

Returns:

the builder to be used for method chaining

addCorrelationParameterValue

public ProcessInstanceStartEventSubscriptionModificationBuilder addCorrelationParameterValue(String parameterName,
 Object parameterValue)

Description copied from interface: ProcessInstanceStartEventSubscriptionModificationBuilder

Adds a specific correlation parameter value for the subscription to be modified. If you register the same correlation parameter values as when creating and registering the event subscription, only that particular one will be modified with this builder. If you want to modify all manually created subscriptions, don't register any correlation parameter values, which would result in all matching the provided process definition and event-registry start event will be modified.

Specified by:

addCorrelationParameterValue in interface ProcessInstanceStartEventSubscriptionModificationBuilder

Parameters:

parameterName - the name of the correlation parameter

parameterValue - the value of the correlation parameter

Returns:

the builder to be used for method chaining

addCorrelationParameterValues

public ProcessInstanceStartEventSubscriptionModificationBuilder addCorrelationParameterValues(Map<String,Object> parameters)

Description copied from interface: ProcessInstanceStartEventSubscriptionModificationBuilder

Registers a list of correlation parameter values for the subscription(s) to be modified.

Specified by:

addCorrelationParameterValues in interface ProcessInstanceStartEventSubscriptionModificationBuilder

Parameters:

parameters - the map of correlation parameter values to be registered for the subscription

Returns:

the builder to be used for method chaining

getProcessDefinitionId

public String getProcessDefinitionId()

hasNewProcessDefinitionId

public boolean hasNewProcessDefinitionId()

getNewProcessDefinitionId

public String getNewProcessDefinitionId()

getTenantId

public String getTenantId()

hasCorrelationParameterValues

public boolean hasCorrelationParameterValues()

getCorrelationParameterValues

public Map<String,Object> getCorrelationParameterValues()

migrateToLatestProcessDefinition

public void migrateToLatestProcessDefinition()

Description copied from interface: ProcessInstanceStartEventSubscriptionModificationBuilder

Migrate all the matching event subscriptions to the latest process definition, which should be done if you want to manually upgrade the subscriptions to the latest version of the process definition.

Specified by:

migrateToLatestProcessDefinition in interface ProcessInstanceStartEventSubscriptionModificationBuilder

migrateToProcessDefinition

public void migrateToProcessDefinition(String processDefinitionId)

Description copied from interface: ProcessInstanceStartEventSubscriptionModificationBuilder

Migrate all matching event subscriptions to the specific process definition.

Specified by:

migrateToProcessDefinition in interface ProcessInstanceStartEventSubscriptionModificationBuilder

Parameters:

processDefinitionId - the id of the process definition to migrate to

checkValidInformation

protected void checkValidInformation()