public class UpdateProcessDefinitionSuspensionStateBuilderImpl extends Object implements UpdateProcessDefinitionSuspensionStateBuilder, UpdateProcessDefinitionSuspensionStateSelectBuilder, UpdateProcessDefinitionSuspensionStateTenantBuilder
Modifier and Type | Field and Description |
---|---|
protected CommandExecutor |
commandExecutor |
protected Date |
executionDate |
protected boolean |
includeProcessInstances |
protected boolean |
isTenantIdSet |
protected String |
processDefinitionId |
protected String |
processDefinitionKey |
protected String |
processDefinitionTenantId |
Constructor and Description |
---|
UpdateProcessDefinitionSuspensionStateBuilderImpl()
Creates a builder without CommandExecutor which can not be used to update
the suspension state via
activate() or suspend() . |
UpdateProcessDefinitionSuspensionStateBuilderImpl(CommandExecutor commandExecutor) |
Modifier and Type | Method and Description |
---|---|
void |
activate()
Activates the provided process definitions.
|
UpdateProcessDefinitionSuspensionStateBuilderImpl |
byProcessDefinitionId(String processDefinitionId)
Selects the process definition with the given id.
|
UpdateProcessDefinitionSuspensionStateBuilderImpl |
byProcessDefinitionKey(String processDefinitionKey)
Selects the process definitions with the given key.
|
UpdateProcessDefinitionSuspensionStateBuilderImpl |
executionDate(Date date)
Specify when the suspension state should be updated.
|
Date |
getExecutionDate() |
String |
getProcessDefinitionId() |
String |
getProcessDefinitionKey() |
String |
getProcessDefinitionTenantId() |
UpdateProcessDefinitionSuspensionStateBuilderImpl |
includeProcessInstances(boolean includeProcessInstance)
Specify if the suspension states of the process instances of the provided
process definitions should also be updated.
|
boolean |
isIncludeProcessInstances() |
boolean |
isTenantIdSet() |
UpdateProcessDefinitionSuspensionStateBuilderImpl |
processDefinitionTenantId(String tenantId)
Specify the id of the tenant the process definition belongs to.
|
UpdateProcessDefinitionSuspensionStateBuilderImpl |
processDefinitionWithoutTenantId()
Specify that the process definition belongs to no tenant.
|
void |
suspend()
Suspends the provided process definitions.
|
protected void |
validateParameters() |
protected final CommandExecutor commandExecutor
protected String processDefinitionKey
protected String processDefinitionId
protected boolean includeProcessInstances
protected Date executionDate
protected String processDefinitionTenantId
protected boolean isTenantIdSet
public UpdateProcessDefinitionSuspensionStateBuilderImpl(CommandExecutor commandExecutor)
public UpdateProcessDefinitionSuspensionStateBuilderImpl()
activate()
or suspend()
. Can be
used in combination with your own command.public UpdateProcessDefinitionSuspensionStateBuilderImpl byProcessDefinitionId(String processDefinitionId)
UpdateProcessDefinitionSuspensionStateSelectBuilder
byProcessDefinitionId
in interface UpdateProcessDefinitionSuspensionStateSelectBuilder
processDefinitionId
- id of the process definitionpublic UpdateProcessDefinitionSuspensionStateBuilderImpl byProcessDefinitionKey(String processDefinitionKey)
UpdateProcessDefinitionSuspensionStateSelectBuilder
byProcessDefinitionKey
in interface UpdateProcessDefinitionSuspensionStateSelectBuilder
processDefinitionKey
- key of the process definitionpublic UpdateProcessDefinitionSuspensionStateBuilderImpl includeProcessInstances(boolean includeProcessInstance)
UpdateProcessDefinitionSuspensionStateBuilder
false
.includeProcessInstances
in interface UpdateProcessDefinitionSuspensionStateBuilder
includeProcessInstance
- if true
, all related process instances will be
activated / suspended too.public UpdateProcessDefinitionSuspensionStateBuilderImpl executionDate(Date date)
UpdateProcessDefinitionSuspensionStateBuilder
executionDate
in interface UpdateProcessDefinitionSuspensionStateBuilder
date
- the date on which the process definition will be activated /
suspended. If null
, the process definition is
activated / suspended immediately.public UpdateProcessDefinitionSuspensionStateBuilderImpl processDefinitionWithoutTenantId()
UpdateProcessDefinitionSuspensionStateTenantBuilder
processDefinitionWithoutTenantId
in interface UpdateProcessDefinitionSuspensionStateTenantBuilder
public UpdateProcessDefinitionSuspensionStateBuilderImpl processDefinitionTenantId(String tenantId)
UpdateProcessDefinitionSuspensionStateTenantBuilder
processDefinitionTenantId
in interface UpdateProcessDefinitionSuspensionStateTenantBuilder
tenantId
- the id of the tenantpublic void activate()
UpdateProcessDefinitionSuspensionStateBuilder
activate
in interface UpdateProcessDefinitionSuspensionStateBuilder
public void suspend()
UpdateProcessDefinitionSuspensionStateBuilder
suspend
in interface UpdateProcessDefinitionSuspensionStateBuilder
protected void validateParameters()
public String getProcessDefinitionKey()
public String getProcessDefinitionId()
public boolean isIncludeProcessInstances()
public Date getExecutionDate()
public String getProcessDefinitionTenantId()
public boolean isTenantIdSet()
Copyright © 2022. All rights reserved.