Package com.aquima.interactions.test.templates.composer

Class FieldValidationTemplate

java.lang.Object
com.aquima.interactions.test.templates.AbstractReportingTemplate
com.aquima.interactions.test.templates.composer.FieldValidationTemplate
public class FieldValidationTemplate extends AbstractReportingTemplate
Template that may be used to quickly initialize a field validation definition.
Since:
7.1
Author:
O. Kerpershoek

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    FieldValidationTemplate(com.aquima.interactions.foundation.report.IInitializationReport report, String type)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addParameter(String key, String paramValue)
    This method may be used to add a parameter value for the validator.
    protected String
    getCondition()
     
    protected com.aquima.interactions.foundation.GUID
    getId()
     
    protected com.aquima.interactions.foundation.text.IMultilingualText
    getMessage()
     
    protected Map<String,String>
    getParameters()
     
    protected String
    getType()
     
    protected boolean
    isBlocking()
     
    protected boolean
    isEssential()
     
    void
    setBlocking(boolean blocking)
    This method may be used to specify if this validation generates a blocking error, or a warning.
    void
    setCondition(String condition)
    This method may be used to specify the condition that should be evaluated to determine if the validation is active.
    void
    setEssential(boolean essential)
    This method may be used to specify if the validation must succeed in order to continue validating.
    void
    setMessage(com.aquima.interactions.foundation.text.IMultilingualText message)
    This method may be used to specify the message that should be used when the validation fails.
    void
    setMessage(String message)
    This method may be used to specify the message that should be used when the validation fails.
    com.aquima.interactions.composer.ds.IFieldValidationDS
    toDataSource()
    This method converts the template to a data source that can be used to initialize a field validation.

    Methods inherited from class com.aquima.interactions.test.templates.AbstractReportingTemplate

    getInitializationReport

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • FieldValidationTemplate

      protected FieldValidationTemplate(com.aquima.interactions.foundation.report.IInitializationReport report, String type)

  • Method Details

    • getId

      protected com.aquima.interactions.foundation.GUID getId()

    • getType

      protected String getType()

    • getCondition

      protected String getCondition()

    • setCondition

      public void setCondition(String condition)
      This method may be used to specify the condition that should be evaluated to determine if the validation is active.
      Parameters:
      condition - the condition that should be evaluated to determine if the validation is active.

    • isBlocking

      protected boolean isBlocking()

    • setBlocking

      public void setBlocking(boolean blocking)
      This method may be used to specify if this validation generates a blocking error, or a warning.
      Parameters:
      blocking - Boolean indicating if the validation is blocking (error).

    • isEssential

      protected boolean isEssential()

    • setEssential

      public void setEssential(boolean essential)
      This method may be used to specify if the validation must succeed in order to continue validating.
      Parameters:
      essential - Boolean indicating that the validation is essential, and must be met in order to continue validating.

    • getMessage

      protected com.aquima.interactions.foundation.text.IMultilingualText getMessage()

    • setMessage

      public void setMessage(String message)
      This method may be used to specify the message that should be used when the validation fails.
      Parameters:
      message - the message that should be used when the validation fails.

    • setMessage

      public void setMessage(com.aquima.interactions.foundation.text.IMultilingualText message)
      This method may be used to specify the message that should be used when the validation fails.
      Parameters:
      message - the message that should be used when the validation fails.

    • addParameter

      public void addParameter(String key, String paramValue)
      This method may be used to add a parameter value for the validator.
      Parameters:
      key - The name of the parameter.
      paramValue - The value for the parameter.

    • getParameters

      protected Map<String,String> getParameters()

    • toDataSource

      public com.aquima.interactions.composer.ds.IFieldValidationDS toDataSource()
      This method converts the template to a data source that can be used to initialize a field validation.
      Returns:
      a data source that can be used to initialize a field validation.