Package com.aquima.interactions.rule.ds

Interface IValidationDS

All Superinterfaces:
IReportingDS, IRuleDS
All Known Implementing Classes:
ReportingValidatorDS, ValidationDelegateDS, ValidationDS, XmlValidationDS, XmlValidationDS
public interface IValidationDS extends IRuleDS
This data source defines the methods that the validation factory may use to initialize a validation rule.
Since:
5.0
Author:
O. Kerpershoek

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getExpression()
    This method returns the expression string that should be used.
    IMultilingualText
    getMessage()
    This method returns a text object containing an explanation that should be used when the validation fails.
    String
    getName()
    This method returns the name of the validation rule.
    int
    getPriority()
    This method returns the priority of the validation.
    String
    getTargetAttribute()
    This method returns the name of the attribute (including the entity name) for which the validation is defined.
    String
    getTypeName()
    This method returns the type of the validation.
    boolean
    isBusinessValidation()
    This method indicates if the validation is a business validation (expression), or if false a normal field (value) validation.
    boolean
    isWarning()
    This method returns a boolean indicating if the failed validation should be treated as warning instead of an error.
    void
    iterateParameters(IValidationParameterVisitor visitor)
    Optional method that may be used to pass additional parameters to the validation.

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

    addMessage

    Methods inherited from interface com.aquima.interactions.rule.ds.IRuleDS

    getRuleGroupNames

  • Method Details

    • getName

      String getName()
      This method returns the name of the validation rule. The name of a validation rule is mostly used to uniquely identify the result of a validation.
      Returns:
      the name of the validation rule.

    • isBusinessValidation

      boolean isBusinessValidation()
      This method indicates if the validation is a business validation (expression), or if false a normal field (value) validation.
      Returns:
      Boolean indicating if this validation is a business validation.

    • getExpression

      String getExpression()
      This method returns the expression string that should be used. The expression is only relevant for business validations.
      Returns:
      the expression string that should be used.

    • getTypeName

      String getTypeName()
      This method returns the type of the validation. The ValidatorType class contains a list of standard supported validation types.
      Returns:
      The type of the validation

    • getMessage

      IMultilingualText getMessage()
      This method returns a text object containing an explanation that should be used when the validation fails.
      Returns:
      Text object containing an explanation about the validation failure.

    • getPriority

      int getPriority()
      This method returns the priority of the validation. The priority is used to determine the order in which validations should be executed.
      Returns:
      the priority of the validation.

    • isWarning

      boolean isWarning()
      This method returns a boolean indicating if the failed validation should be treated as warning instead of an error. When this method returns false (default), a failed validation will be treated as error.
      Returns:
      boolean indicating if the failed validation should be treated as warning

    • getTargetAttribute

      String getTargetAttribute()
      This method returns the name of the attribute (including the entity name) for which the validation is defined.
      Returns:
      The name of the attribute for which the validation is defined.

    • iterateParameters

      void iterateParameters(IValidationParameterVisitor visitor)
      Optional method that may be used to pass additional parameters to the validation.
      Parameters:
      visitor - the visitor which accepts the parameter information