Package com.flowable.platform.api.repository.datadictionary.validation

Interface DataDictionaryValidationBuilder

All Known Implementing Classes:
DataDictionaryValidatorImpl.DataDictionaryValidationBuilderImpl
public interface DataDictionaryValidationBuilder
This interface defines a builder for validating data against a specified data dictionary type. It allows for configuring various aspects of validation, such as type properties, overall type, value to validate, and the level of validation (type check only or full validation).

  • Method Details

    • typeProperty

      DataDictionaryValidationBuilder typeProperty(TypeProperty property)
      Adds a type property to the validation configuration.
      Parameters:
      property - The TypeProperty that describes the expected type and constraints of the property.
      Returns:
      The current instance for chaining method calls.

    • type

      DataDictionaryValidationBuilder type(DictionaryType type)
      Sets the DictionaryType for the validation.
      Parameters:
      type - The DictionaryType to be used in the validation process.
      Returns:
      The current instance for chaining method calls.

    • value

      DataDictionaryValidationBuilder value(Object valueToValidate)
      Specifies the value to be validated.
      Parameters:
      valueToValidate - The value that will be subjected to validation.
      Returns:
      The current instance for chaining method calls.

    • variableName

      DataDictionaryValidationBuilder variableName(String variableName)
      Sets the name of the variable associated with the value being validated. This can be used for identification purposes in the validation results.
      Parameters:
      variableName - The name of the variable.
      Returns:
      The current instance for chaining method calls.

    • typeValidationOnly

      DataDictionaryValidationBuilder typeValidationOnly()
      Configures the builder to perform only a type compatibility check, bypassing other constraint checks.
      Returns:
      The current instance for chaining method calls.

    • validate

      ValidationResult validate()
      Executes the validation process based on the configured parameters.
      Returns:
      ValidationResult An object containing the results of the validation process.