org.camunda.bpm.engine.impl.repository

Class DeleteProcessDefinitionsBuilderImpl

java.lang.Object

org.camunda.bpm.engine.impl.repository.DeleteProcessDefinitionsBuilderImpl

All Implemented Interfaces:

DeleteProcessDefinitionsBuilder, DeleteProcessDefinitionsSelectBuilder, DeleteProcessDefinitionsTenantBuilder

public class DeleteProcessDefinitionsBuilderImpl
extends Object
implements DeleteProcessDefinitionsBuilder, DeleteProcessDefinitionsSelectBuilder, DeleteProcessDefinitionsTenantBuilder

Fluent builder implementation to delete process definitions.

Author:

Tassilo Weidner

Constructor Summary

Constructors

Constructor and Description
DeleteProcessDefinitionsBuilderImpl(CommandExecutor commandExecutor)

Method Summary

Methods

Modifier and Type	Method and Description
DeleteProcessDefinitionsBuilderImpl	byIds(String... processDefinitionId) Selects process definitions with given process definition ids.
DeleteProcessDefinitionsBuilderImpl	byKey(String processDefinitionKey) Selects process definitions with a given key.
DeleteProcessDefinitionsBuilderImpl	cascade() All process instances of the process definition as well as history data is deleted.
void	delete() Performs the deletion of process definitions.
DeleteProcessDefinitionsBuilderImpl	skipCustomListeners() Only the built-in ExecutionListeners are notified with the ExecutionListener.EVENTNAME_END event.
DeleteProcessDefinitionsBuilderImpl	withoutTenantId() Process definitions which belong to no tenant will be removed.
DeleteProcessDefinitionsBuilderImpl	withTenantId(String tenantId) Process definitions which belong to the given tenant id will be removed.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeleteProcessDefinitionsBuilderImpl

public DeleteProcessDefinitionsBuilderImpl(CommandExecutor commandExecutor)

Method Detail

byIds

public DeleteProcessDefinitionsBuilderImpl byIds(String... processDefinitionId)

Description copied from interface: DeleteProcessDefinitionsSelectBuilder

Selects process definitions with given process definition ids.

Specified by:

byIds in interface DeleteProcessDefinitionsSelectBuilder

Parameters:

processDefinitionId - at least one process definition id

Returns:

the builder

byKey

public DeleteProcessDefinitionsBuilderImpl byKey(String processDefinitionKey)

Description copied from interface: DeleteProcessDefinitionsSelectBuilder

Selects process definitions with a given key.

Specified by:

byKey in interface DeleteProcessDefinitionsSelectBuilder

Parameters:

processDefinitionKey - process definition key

Returns:

the builder

withoutTenantId

public DeleteProcessDefinitionsBuilderImpl withoutTenantId()

Description copied from interface: DeleteProcessDefinitionsTenantBuilder

Process definitions which belong to no tenant will be removed.

Specified by:

withoutTenantId in interface DeleteProcessDefinitionsTenantBuilder

Returns:

the builder

withTenantId

public DeleteProcessDefinitionsBuilderImpl withTenantId(String tenantId)

Description copied from interface: DeleteProcessDefinitionsTenantBuilder

Process definitions which belong to the given tenant id will be removed.

Specified by:

withTenantId in interface DeleteProcessDefinitionsTenantBuilder

Parameters:

tenantId - id which identifies the tenant

Returns:

the builder

cascade

public DeleteProcessDefinitionsBuilderImpl cascade()

Description copied from interface: DeleteProcessDefinitionsBuilder

All process instances of the process definition as well as history data is deleted.

Specified by:

cascade in interface DeleteProcessDefinitionsBuilder

Returns:

the builder

skipCustomListeners

public DeleteProcessDefinitionsBuilderImpl skipCustomListeners()

Description copied from interface: DeleteProcessDefinitionsBuilder

Only the built-in ExecutionListeners are notified with the ExecutionListener.EVENTNAME_END event. Is only applied in conjunction with the cascade method.

Specified by:

skipCustomListeners in interface DeleteProcessDefinitionsBuilder

Returns:

the builder

delete

public void delete()

Description copied from interface: DeleteProcessDefinitionsBuilder

Performs the deletion of process definitions.

Specified by:

delete in interface DeleteProcessDefinitionsBuilder