Package org.flowable.engine.impl.runtime

Class ProcessInstanceStartEventSubscriptionDeletionBuilderImpl

java.lang.Object

org.flowable.engine.impl.runtime.ProcessInstanceStartEventSubscriptionDeletionBuilderImpl

All Implemented Interfaces:

ProcessInstanceStartEventSubscriptionDeletionBuilder

public class ProcessInstanceStartEventSubscriptionDeletionBuilderImpl
extends Object
implements ProcessInstanceStartEventSubscriptionDeletionBuilder

The implementation for a process start event subscription deletion builder.

Author:

Micha Kiener

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
ProcessInstanceStartEventSubscriptionDeletionBuilderImpl(RuntimeServiceImpl runtimeService)

Method Summary

Modifier and Type	Method	Description
ProcessInstanceStartEventSubscriptionDeletionBuilder	addCorrelationParameterValue(String parameterName, Object parameterValue)	Adds a specific correlation parameter value for the subscription to be deleted.
ProcessInstanceStartEventSubscriptionDeletionBuilder	addCorrelationParameterValues(Map<String,Object> parameters)	Registers a list of correlation parameter values for the subscription(s) to be deleted.
protected void	checkValidInformation()
void	deleteSubscriptions()	Deletes all the matching event subscriptions.
Map<String,Object>	getCorrelationParameterValues()
String	getProcessDefinitionId()
String	getTenantId()
boolean	hasCorrelationParameterValues()
ProcessInstanceStartEventSubscriptionDeletionBuilder	processDefinitionId(String processDefinitionId)	Set the process definition using its specific id the manually created subscription is based on.
ProcessInstanceStartEventSubscriptionDeletionBuilder	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

tenantId

protected String tenantId

correlationParameterValues

protected final Map<String,Object> correlationParameterValues

Constructor Details

ProcessInstanceStartEventSubscriptionDeletionBuilderImpl

public ProcessInstanceStartEventSubscriptionDeletionBuilderImpl(RuntimeServiceImpl runtimeService)

Method Details

processDefinitionId

public ProcessInstanceStartEventSubscriptionDeletionBuilder processDefinitionId(String processDefinitionId)

Description copied from interface: ProcessInstanceStartEventSubscriptionDeletionBuilder

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 ProcessInstanceStartEventSubscriptionDeletionBuilder

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 ProcessInstanceStartEventSubscriptionDeletionBuilder tenantId(String tenantId)

Description copied from interface: ProcessInstanceStartEventSubscriptionDeletionBuilder

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 ProcessInstanceStartEventSubscriptionDeletionBuilder

Parameters:

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

Returns:

the builder to be used for method chaining

addCorrelationParameterValue

public ProcessInstanceStartEventSubscriptionDeletionBuilder addCorrelationParameterValue(String parameterName,
 Object parameterValue)

Description copied from interface: ProcessInstanceStartEventSubscriptionDeletionBuilder

Adds a specific correlation parameter value for the subscription to be deleted. If you register the same correlation parameter values as when creating and registering the event subscription, only that particular one will be deleted with this builder. If you want to delete 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 deleted.

Specified by:

addCorrelationParameterValue in interface ProcessInstanceStartEventSubscriptionDeletionBuilder

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 ProcessInstanceStartEventSubscriptionDeletionBuilder addCorrelationParameterValues(Map<String,Object> parameters)

Description copied from interface: ProcessInstanceStartEventSubscriptionDeletionBuilder

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

Specified by:

addCorrelationParameterValues in interface ProcessInstanceStartEventSubscriptionDeletionBuilder

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()

getTenantId

public String getTenantId()

hasCorrelationParameterValues

public boolean hasCorrelationParameterValues()

getCorrelationParameterValues

public Map<String,Object> getCorrelationParameterValues()

deleteSubscriptions

public void deleteSubscriptions()

Description copied from interface: ProcessInstanceStartEventSubscriptionDeletionBuilder

Deletes all the matching event subscriptions.

Specified by:

deleteSubscriptions in interface ProcessInstanceStartEventSubscriptionDeletionBuilder

checkValidInformation

protected void checkValidInformation()