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

Class CaseInstanceStartEventSubscriptionModificationBuilderImpl

java.lang.Object

org.flowable.cmmn.engine.impl.runtime.CaseInstanceStartEventSubscriptionModificationBuilderImpl

All Implemented Interfaces:

CaseInstanceStartEventSubscriptionModificationBuilder

public class CaseInstanceStartEventSubscriptionModificationBuilderImpl
extends Object
implements CaseInstanceStartEventSubscriptionModificationBuilder

The implementation for a case start event subscription modification 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	newCaseDefinitionId
protected String	tenantId

Constructor Summary

Constructors

Constructor	Description
CaseInstanceStartEventSubscriptionModificationBuilderImpl(CmmnRuntimeServiceImpl cmmnRuntimeService)

Method Summary

Modifier and Type	Method	Description
CaseInstanceStartEventSubscriptionModificationBuilder	addCorrelationParameterValue(String parameterName, Object parameterValue)	Adds a specific correlation parameter value for the subscription to be modified.
CaseInstanceStartEventSubscriptionModificationBuilder	addCorrelationParameterValues(Map<String,Object> parameters)	Registers a list of correlation parameter values for the subscription(s) to be modified.
CaseInstanceStartEventSubscriptionModificationBuilder	caseDefinitionId(String caseDefinitionId)	Set the case definition using its specific id the manually created subscription is based on.
protected void	checkValidInformation()
String	getCaseDefinitionId()
Map<String,Object>	getCorrelationParameterValues()
String	getNewCaseDefinitionId()
String	getTenantId()
boolean	hasCorrelationParameterValues()
boolean	hasNewCaseDefinitionId()
void	migrateToCaseDefinition(String caseDefinitionId)	Migrate all matching event subscriptions to the specific case definition.
void	migrateToLatestCaseDefinition()	Migrate all the matching event subscriptions to the latest case definition, which should be done if you want to manually upgrade the subscriptions to the latest version of the case definition.
CaseInstanceStartEventSubscriptionModificationBuilder	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

newCaseDefinitionId

protected String newCaseDefinitionId

tenantId

protected String tenantId

correlationParameterValues

protected final Map<String,Object> correlationParameterValues

Constructor Details

CaseInstanceStartEventSubscriptionModificationBuilderImpl

public CaseInstanceStartEventSubscriptionModificationBuilderImpl(CmmnRuntimeServiceImpl cmmnRuntimeService)

Method Details

caseDefinitionId

public CaseInstanceStartEventSubscriptionModificationBuilder caseDefinitionId(String caseDefinitionId)

Description copied from interface: CaseInstanceStartEventSubscriptionModificationBuilder

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 CaseInstanceStartEventSubscriptionModificationBuilder

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

Description copied from interface: CaseInstanceStartEventSubscriptionModificationBuilder

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 CaseInstanceStartEventSubscriptionModificationBuilder

Parameters:

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

Returns:

the builder to be used for method chaining

addCorrelationParameterValue

public CaseInstanceStartEventSubscriptionModificationBuilder addCorrelationParameterValue(String parameterName,
 Object parameterValue)

Description copied from interface: CaseInstanceStartEventSubscriptionModificationBuilder

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

Specified by:

addCorrelationParameterValue in interface CaseInstanceStartEventSubscriptionModificationBuilder

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

Description copied from interface: CaseInstanceStartEventSubscriptionModificationBuilder

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

Specified by:

addCorrelationParameterValues in interface CaseInstanceStartEventSubscriptionModificationBuilder

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

hasNewCaseDefinitionId

public boolean hasNewCaseDefinitionId()

getNewCaseDefinitionId

public String getNewCaseDefinitionId()

getTenantId

public String getTenantId()

hasCorrelationParameterValues

public boolean hasCorrelationParameterValues()

getCorrelationParameterValues

public Map<String,Object> getCorrelationParameterValues()

migrateToLatestCaseDefinition

public void migrateToLatestCaseDefinition()

Description copied from interface: CaseInstanceStartEventSubscriptionModificationBuilder

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

Specified by:

migrateToLatestCaseDefinition in interface CaseInstanceStartEventSubscriptionModificationBuilder

migrateToCaseDefinition

public void migrateToCaseDefinition(String caseDefinitionId)

Description copied from interface: CaseInstanceStartEventSubscriptionModificationBuilder

Migrate all matching event subscriptions to the specific case definition.

Specified by:

migrateToCaseDefinition in interface CaseInstanceStartEventSubscriptionModificationBuilder

Parameters:

caseDefinitionId - the id of the case definition to migrate to

checkValidInformation

protected void checkValidInformation()