Package org.flowable.engine.runtime

Interface ProcessInstanceStartEventSubscriptionDeletionBuilder

public interface ProcessInstanceStartEventSubscriptionDeletionBuilder
A builder API to delete a manually created process start event subscription which was created and registered using the RuntimeService#createProcessStartEventSubscriptionBuilder() builder API. With this API you can delete one or more such subscriptions based on the correlation parameter values and event type.
Author:
Micha Kiener

  • Method Details

    • processDefinitionId

      ProcessInstanceStartEventSubscriptionDeletionBuilder processDefinitionId(String processDefinitionId)
      Set the process definition using its specific id the manually created subscription is based on. This is mandatory and must be provided.
      Parameters:
      processDefinitionId - the id of the process definition the subscription is based on (an exact version of it)
      Returns:
      the builder to be used for method chaining

    • tenantId

      ProcessInstanceStartEventSubscriptionDeletionBuilder 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.
      Parameters:
      tenantId - the id of the tenant the subscription is created for
      Returns:
      the builder to be used for method chaining

    • addCorrelationParameterValue

      ProcessInstanceStartEventSubscriptionDeletionBuilder addCorrelationParameterValue(String parameterName, Object parameterValue)
      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 process definition and event-registry start event will be deleted.
      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

      ProcessInstanceStartEventSubscriptionDeletionBuilder addCorrelationParameterValues(Map<String,Object> parameters)
      Registers a list of correlation parameter values for the subscription(s) to be deleted.
      Parameters:
      parameters - the map of correlation parameter values to be registered for the subscription
      Returns:
      the builder to be used for method chaining

    • deleteSubscriptions

      void deleteSubscriptions()
      Deletes all the matching event subscriptions.