Package com.aquima.interactions.composer

Interface IFieldValidation

All Superinterfaces:
Serializable
All Known Implementing Classes:
FieldValidation
public interface IFieldValidation extends Serializable
This interface defines the methods of a validator for field values. The composers only defines validator types, the actual validation is not done by the composer.
Since:
7.1
Author:
O. Kerpershoek

  • Method Summary

    Modifier and Type
    Method
    Description
    IMultilingualText
    getMessage()
    This method returns the message that should be shown in case the validation fails.
    String
    getMessageId()
    This method returns the message Id that should be shown in case the validation fails.
    String[]
    getParameterNames()
    This method returns an array containing the parameter names for which a parameter value is defined.
    String
    getParameterValue(String key)
    This method returns the value for the specified parameter name.
    String
    getTypeName()
    This method returns the type name of the validator that should be used for the field.
    boolean
    isBlocking()
    This method returns a boolean indicating if the validation is blocking is not successful.
    boolean
    isEssential()
    This method returns a boolean indicating if the validation may be considered a fatal error, and further validation of the value is not needed.

  • Method Details

    • getTypeName

      String getTypeName()
      This method returns the type name of the validator that should be used for the field.
      Returns:
      The type name of the validator.

    • isBlocking

      boolean isBlocking()
      This method returns a boolean indicating if the validation is blocking is not successful.
      Returns:
      boolean indicating if the validation is blocking is not successful.

    • isEssential

      boolean isEssential()
      This method returns a boolean indicating if the validation may be considered a fatal error, and further validation of the value is not needed.
      Returns:
      Boolean indicating that the validation is essential and must succeed for any further validation to be useful.

    • getParameterNames

      String[] getParameterNames()
      This method returns an array containing the parameter names for which a parameter value is defined.
      Returns:
      array containing the parameter names for which a parameter value is defined.

    • getParameterValue

      String getParameterValue(String key)
      This method returns the value for the specified parameter name. If there is no value specified for the parameter, a null value is returned.
      Parameters:
      key - The name of the parameter for which the value is requested.
      Returns:
      The value for the specified parameter.

    • getMessage

      IMultilingualText getMessage()
      This method returns the message that should be shown in case the validation fails.
      Returns:
      The message that should be shown in case the validation fails.

    • getMessageId

      String getMessageId()
      This method returns the message Id that should be shown in case the validation fails.
      Returns:
      The message id that should be shown in case the validation fails.