org.camunda.bpm.engine.impl.management

Class UpdateJobSuspensionStateBuilderImpl

java.lang.Object

org.camunda.bpm.engine.impl.management.UpdateJobSuspensionStateBuilderImpl

All Implemented Interfaces:

UpdateJobSuspensionStateBuilder, UpdateJobSuspensionStateSelectBuilder, UpdateJobSuspensionStateTenantBuilder

public class UpdateJobSuspensionStateBuilderImpl
extends Object
implements UpdateJobSuspensionStateBuilder, UpdateJobSuspensionStateSelectBuilder, UpdateJobSuspensionStateTenantBuilder

Field Summary

Fields

Modifier and Type	Field and Description
protected CommandExecutor	commandExecutor
protected boolean	isProcessDefinitionTenantIdSet
protected String	jobDefinitionId
protected String	jobId
protected String	processDefinitionId
protected String	processDefinitionKey
protected String	processDefinitionTenantId
protected String	processInstanceId

Constructor Summary

Constructors

Constructor and Description
UpdateJobSuspensionStateBuilderImpl() Creates a builder without CommandExecutor which can not be used to update the suspension state via activate() or suspend().
UpdateJobSuspensionStateBuilderImpl(CommandExecutor commandExecutor)

Method Summary

Methods

Modifier and Type	Method and Description
void	activate() Activates the provided jobs.
UpdateJobSuspensionStateBuilderImpl	byJobDefinitionId(String jobDefinitionId) Selects the jobs of the job definition with the given id.
UpdateJobSuspensionStateBuilderImpl	byJobId(String jobId) Selects the job with the given id.
UpdateJobSuspensionStateBuilderImpl	byProcessDefinitionId(String processDefinitionId) Selects the jobs of the process definition with the given id.
UpdateJobSuspensionStateBuilderImpl	byProcessDefinitionKey(String processDefinitionKey) Selects the jobs of the process definitions with the given key.
UpdateJobSuspensionStateBuilderImpl	byProcessInstanceId(String processInstanceId) Selects the jobs of the process instance with the given id.
String	getJobDefinitionId()
String	getJobId()
String	getProcessDefinitionId()
String	getProcessDefinitionKey()
String	getProcessDefinitionTenantId()
String	getProcessInstanceId()
boolean	isProcessDefinitionTenantIdSet()
UpdateJobSuspensionStateBuilderImpl	processDefinitionTenantId(String tenantId) Specify the id of the tenant the process definition belongs to.
UpdateJobSuspensionStateBuilderImpl	processDefinitionWithoutTenantId() Specify that the process definition belongs to no tenant.
void	suspend() Suspends the provided jobs.
protected void	validateParameters()

Methods inherited from class java.lang.Object

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

Field Detail

commandExecutor

protected final CommandExecutor commandExecutor

jobId

protected String jobId

jobDefinitionId

protected String jobDefinitionId

processInstanceId

protected String processInstanceId

processDefinitionKey

protected String processDefinitionKey

processDefinitionId

protected String processDefinitionId

processDefinitionTenantId

protected String processDefinitionTenantId

isProcessDefinitionTenantIdSet

protected boolean isProcessDefinitionTenantIdSet

Constructor Detail

UpdateJobSuspensionStateBuilderImpl

public UpdateJobSuspensionStateBuilderImpl(CommandExecutor commandExecutor)

UpdateJobSuspensionStateBuilderImpl

public UpdateJobSuspensionStateBuilderImpl()

Creates a builder without CommandExecutor which can not be used to update the suspension state via activate() or suspend(). Can be used in combination with your own command.

Method Detail

byJobId

public UpdateJobSuspensionStateBuilderImpl byJobId(String jobId)

Description copied from interface: UpdateJobSuspensionStateSelectBuilder

Selects the job with the given id.

Specified by:

byJobId in interface UpdateJobSuspensionStateSelectBuilder

Parameters:

jobId - id of the job

Returns:

the builder

byJobDefinitionId

public UpdateJobSuspensionStateBuilderImpl byJobDefinitionId(String jobDefinitionId)

Description copied from interface: UpdateJobSuspensionStateSelectBuilder

Selects the jobs of the job definition with the given id.

Specified by:

byJobDefinitionId in interface UpdateJobSuspensionStateSelectBuilder

Parameters:

jobDefinitionId - id of the job definition

Returns:

the builder

byProcessInstanceId

public UpdateJobSuspensionStateBuilderImpl byProcessInstanceId(String processInstanceId)

Description copied from interface: UpdateJobSuspensionStateSelectBuilder

Selects the jobs of the process instance with the given id.

Specified by:

byProcessInstanceId in interface UpdateJobSuspensionStateSelectBuilder

Parameters:

processInstanceId - id of the process instance

Returns:

the builder

byProcessDefinitionId

public UpdateJobSuspensionStateBuilderImpl byProcessDefinitionId(String processDefinitionId)

Description copied from interface: UpdateJobSuspensionStateSelectBuilder

Selects the jobs of the process definition with the given id.

Specified by:

byProcessDefinitionId in interface UpdateJobSuspensionStateSelectBuilder

Parameters:

processDefinitionId - id of the process definition

Returns:

the builder

byProcessDefinitionKey

public UpdateJobSuspensionStateBuilderImpl byProcessDefinitionKey(String processDefinitionKey)

Description copied from interface: UpdateJobSuspensionStateSelectBuilder

Selects the jobs of the process definitions with the given key.

Specified by:

byProcessDefinitionKey in interface UpdateJobSuspensionStateSelectBuilder

Parameters:

processDefinitionKey - key of the process definition

Returns:

the builder

processDefinitionWithoutTenantId

public UpdateJobSuspensionStateBuilderImpl processDefinitionWithoutTenantId()

Description copied from interface: UpdateJobSuspensionStateTenantBuilder

Specify that the process definition belongs to no tenant.

Specified by:

processDefinitionWithoutTenantId in interface UpdateJobSuspensionStateTenantBuilder

Returns:

the builder

processDefinitionTenantId

public UpdateJobSuspensionStateBuilderImpl processDefinitionTenantId(String tenantId)

Description copied from interface: UpdateJobSuspensionStateTenantBuilder

Specify the id of the tenant the process definition belongs to.

Specified by:

processDefinitionTenantId in interface UpdateJobSuspensionStateTenantBuilder

Parameters:

tenantId - the id of the tenant

Returns:

the builder

activate

public void activate()

Description copied from interface: UpdateJobSuspensionStateBuilder

Activates the provided jobs.

Specified by:

activate in interface UpdateJobSuspensionStateBuilder

suspend

public void suspend()

Description copied from interface: UpdateJobSuspensionStateBuilder

Suspends the provided jobs. If a job is in state suspended, it will not be executed by the job executor.

Specified by:

suspend in interface UpdateJobSuspensionStateBuilder

validateParameters

protected void validateParameters()

getProcessDefinitionKey

public String getProcessDefinitionKey()

getProcessDefinitionId

public String getProcessDefinitionId()

getProcessDefinitionTenantId

public String getProcessDefinitionTenantId()

isProcessDefinitionTenantIdSet

public boolean isProcessDefinitionTenantIdSet()

getJobId

public String getJobId()

getJobDefinitionId

public String getJobDefinitionId()

getProcessInstanceId

public String getProcessInstanceId()