Package com.aquima.interactions.process.impl.builder

Class ProcessEngineSettingsBuilder

java.lang.Object
com.aquima.interactions.process.impl.builder.ProcessEngineSettingsBuilder
public class ProcessEngineSettingsBuilder extends Object
A builder that creates an IProcessEngineSettings implementation using IgnoreModeSettingsBuilder for the ignore mode settings.
Since:
9.8.5
Author:
Petru Galanton

  • Constructor Details

    • ProcessEngineSettingsBuilder

      public ProcessEngineSettingsBuilder()
      Creates a builder that uses IgnoreModeSettingsBuilder for building the ignore mode settings. See IgnoreModeSettingsBuilder for details on what rules apply.

    • ProcessEngineSettingsBuilder

      public ProcessEngineSettingsBuilder(IgnoreModeSettingsBuilder ignoreModeBuilder)
      Allows using a different IgnoreModeSettingsBuilder, with potentially different rules than the default ones.
      Parameters:
      ignoreModeBuilder - the builder used to build the ignore mode settings.

  • Method Details

    • setCancelStartedTasks

      public ProcessEngineSettingsBuilder setCancelStartedTasks(boolean cancelStartedTasks)
      Sets whether started tasks should be canceled when the runtime starts.
      Parameters:
      cancelStartedTasks - whether to cancel started tasks
      Returns:
      this builder for method chaining

    • setRetainRequiredTasks

      public ProcessEngineSettingsBuilder setRetainRequiredTasks(boolean retainRequiredTasks)
      Sets whether required tasks should stay available once their precondition becomes false
      Parameters:
      retainRequiredTasks - true for retaining required tasks, false otherwise
      Returns:
      this builder for method chaining

    • setWorkListLimit

      public ProcessEngineSettingsBuilder setWorkListLimit(Integer limit)
      Sets the limit on total rows displayed in work lists (in total).
      Parameters:
      limit - the limit
      Returns:
      this builder for method chaining

    • setCaseListLimit

      public ProcessEngineSettingsBuilder setCaseListLimit(Integer limit)
      Sets the limit on total rows displayed in case lists (in total).
      Parameters:
      limit - the limit
      Returns:
      this builder for method chaining

    • setIgnoreMode

      public ProcessEngineSettingsBuilder setIgnoreMode(IgnoreMode mode)
      Sets the global ignore mode.
      Parameters:
      mode - the global ignore mode
      Returns:
      this builder for method chaining

    • setIgnoreMode

      public ProcessEngineSettingsBuilder setIgnoreMode(String appName, IgnoreMode mode)
      Sets the ignore mode for a specific application.
      Parameters:
      appName - the application name
      mode - the ignore mode
      Returns:
      this builder for method chaining

    • setIgnoreUnknownAttributes

      public ProcessEngineSettingsBuilder setIgnoreUnknownAttributes(boolean ignore)
      Sets whether unknown attributes are ignored by default.
      Parameters:
      ignore - true if by default unknown attributes are ignored, false otherwise
      Returns:
      this builder for method chaining

    • setIgnoreUnknownAttributes

      public ProcessEngineSettingsBuilder setIgnoreUnknownAttributes(String applicationName, boolean ignore)
      Sets whether unknown attributes for the application with the given name are ignored. This setting overrides the default.
      Parameters:
      applicationName - the application name, not null.
      ignore - whether to ignore unknown attributes
      Returns:
      this builder for method chaining

    • setIgnoreUnknownEntities

      public ProcessEngineSettingsBuilder setIgnoreUnknownEntities(boolean ignore)
      Sets whether unknown entities are ignored by default.
      Parameters:
      ignore - true if by default unknown entities are ignored, false otherwise
      Returns:
      this builder for method chaining

    • setIgnoreUnknownEntities

      public ProcessEngineSettingsBuilder setIgnoreUnknownEntities(String applicationName, boolean ignore)
      Sets whether unknown entities for the application with the given name are ignored. This setting overrides the default.
      Parameters:
      applicationName - the application name, not null.
      ignore - whether to ignore unknown entities
      Returns:
      this builder for method chaining

    • build

      public IProcessEngineSettings build()
      Builds the IProcessEngineSettings based on values set so far. The builder can be reused after this method is called, but it retains all existing settings.
      Returns:
      the IProcessEngineSettings with the settings set so far on this builder.