Package com.aquima.interactions.communication.ds

Interface IFieldValidationDS

All Superinterfaces:
IReportingDS
All Known Implementing Classes:
ReportingFieldValidationDS, XmlFieldValidationDS, XmlFieldValidationDS
public interface IFieldValidationDS extends IReportingDS
This interface defines an validation of an attribute.
Since:
9.0
Author:
Arjan Pragt, Jon van Leuven

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCondition()
    This method returns the condition that should be evaluated to determine if the validation should be active.
    IMultilingualText
    getMessage()
    This method returns the text that should be shown when a value does not pass the validation.
    String
    getType()
    this method return the name of the validator type.
    void
    iterateParameters(IFieldValidationParameterVisitor visitor)
    This method returns a map containing parameters for the validator.

    Methods inherited from interface com.aquima.interactions.foundation.report.IReportingDS

    addMessage

  • Method Details

    • getType

      String getType()
      this method return the name of the validator type.
      Returns:
      the name of the validator type.

    • getMessage

      IMultilingualText getMessage()
      This method returns the text that should be shown when a value does not pass the validation. The text may contain TSL, the message will be expanded after the (invalid) value is evaluated.
      Returns:
      text that should be shown when a value does not pass the validation.

    • getCondition

      String getCondition()
      This method returns the condition that should be evaluated to determine if the validation should be active.
      Returns:
      the condition that should be evaluated to determine if the validation should be active.

    • iterateParameters

      void iterateParameters(IFieldValidationParameterVisitor visitor)
      This method returns a map containing parameters for the validator. If the validator does not require any parameters.
      Parameters:
      visitor - the visitor which accepts the parameter information
      Throws:
      InitializationException - When the parameters could not be added.