Package org.flowable.cmmn.engine.impl.runtime

Class CaseInstanceStartEventSubscriptionDeletionBuilderImpl

java.lang.Object

org.flowable.cmmn.engine.impl.runtime.CaseInstanceStartEventSubscriptionDeletionBuilderImpl

All Implemented Interfaces:

CaseInstanceStartEventSubscriptionDeletionBuilder

public class CaseInstanceStartEventSubscriptionDeletionBuilderImpl
extends Object
implements CaseInstanceStartEventSubscriptionDeletionBuilder

The implementation for a case start event subscription deletion builder.

Author:

Micha Kiener

Field Summary

Fields

Modifier and Type	Field	Description
protected String	caseDefinitionId
protected final CmmnRuntimeServiceImpl	cmmnRuntimeService
protected final Map<String,Object>	correlationParameterValues
protected String	tenantId

Constructor Summary

Constructors

Constructor	Description
CaseInstanceStartEventSubscriptionDeletionBuilderImpl(CmmnRuntimeServiceImpl runtimeService)

Method Summary

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

cmmnRuntimeService

protected final CmmnRuntimeServiceImpl cmmnRuntimeService

caseDefinitionId

protected String caseDefinitionId

tenantId

protected String tenantId

correlationParameterValues

protected final Map<String,Object> correlationParameterValues

Constructor Details

CaseInstanceStartEventSubscriptionDeletionBuilderImpl

public CaseInstanceStartEventSubscriptionDeletionBuilderImpl(CmmnRuntimeServiceImpl runtimeService)

Method Details

caseDefinitionId

public CaseInstanceStartEventSubscriptionDeletionBuilder caseDefinitionId(String caseDefinitionId)

Description copied from interface: CaseInstanceStartEventSubscriptionDeletionBuilder

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

Specified by:

caseDefinitionId in interface CaseInstanceStartEventSubscriptionDeletionBuilder

Parameters:

caseDefinitionId - the id of the case definition the subscription is based on (an exact version of it)

Returns:

the builder to be used for method chaining

tenantId

public CaseInstanceStartEventSubscriptionDeletionBuilder tenantId(String tenantId)

Description copied from interface: CaseInstanceStartEventSubscriptionDeletionBuilder

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 CaseInstanceStartEventSubscriptionDeletionBuilder

Parameters:

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

Returns:

the builder to be used for method chaining

addCorrelationParameterValue

public CaseInstanceStartEventSubscriptionDeletionBuilder addCorrelationParameterValue(String parameterName,
 Object parameterValue)

Description copied from interface: CaseInstanceStartEventSubscriptionDeletionBuilder

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 case definition and event-registry start event will be deleted.

Specified by:

addCorrelationParameterValue in interface CaseInstanceStartEventSubscriptionDeletionBuilder

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

Description copied from interface: CaseInstanceStartEventSubscriptionDeletionBuilder

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

Specified by:

addCorrelationParameterValues in interface CaseInstanceStartEventSubscriptionDeletionBuilder

Parameters:

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

Returns:

the builder to be used for method chaining

getCaseDefinitionId

public String getCaseDefinitionId()

getTenantId

public String getTenantId()

hasCorrelationParameterValues

public boolean hasCorrelationParameterValues()

getCorrelationParameterValues

public Map<String,Object> getCorrelationParameterValues()

deleteSubscriptions

public void deleteSubscriptions()

Description copied from interface: CaseInstanceStartEventSubscriptionDeletionBuilder

Deletes all the matching event subscriptions.

Specified by:

deleteSubscriptions in interface CaseInstanceStartEventSubscriptionDeletionBuilder

checkValidInformation

protected void checkValidInformation()