Class CriteriaOutputSettings

All Implemented Interfaces:
HasHandlers

public class CriteriaOutputSettings extends DataClass
Settings for generation of AdvancedCriteria descriptions.
  • Constructor Details

    • CriteriaOutputSettings

      public CriteriaOutputSettings()
    • CriteriaOutputSettings

      public CriteriaOutputSettings(JavaScriptObject jsObj)
  • Method Details

    • getOrCreateRef

      public static CriteriaOutputSettings getOrCreateRef(JavaScriptObject jsObj)
    • setEscapeHTML

      public CriteriaOutputSettings setEscapeHTML(Boolean escapeHTML)
      By default HTML characters such as "<br>" will be written into the output description to format the result. Setting escapeHTML true will instead force HTML values in the output to be displayed to the user instead.
      Parameters:
      escapeHTML - New escapeHTML value. Default value is null
      Returns:
      CriteriaOutputSettings instance, for chaining setter calls
    • getEscapeHTML

      public Boolean getEscapeHTML()
      By default HTML characters such as "<br>" will be written into the output description to format the result. Setting escapeHTML true will instead force HTML values in the output to be displayed to the user instead.
      Returns:
      Current escapeHTML value. Default value is null
    • setPrefix

      public CriteriaOutputSettings setPrefix(String prefix)
      Prefix to be prepended to each criterion description.
      Parameters:
      prefix - New prefix value. Default value is null
      Returns:
      CriteriaOutputSettings instance, for chaining setter calls
    • getPrefix

      public String getPrefix()
      Prefix to be prepended to each criterion description.
      Returns:
      Current prefix value. Default value is null
    • setQuoteTextValues

      public CriteriaOutputSettings setQuoteTextValues(Boolean quoteTextValues)
      When set, values of substring-style operators such as "contains" or "startsWith" (including their case-insensitive and negated variants - any operator declaring textMatch) are surrounded with double quotes in the output, so a value containing the words "and" or "or" cannot read as a further clause of the sentence. When unset, values appear unquoted.
      Parameters:
      quoteTextValues - New quoteTextValues value. Default value is null
      Returns:
      CriteriaOutputSettings instance, for chaining setter calls
    • getQuoteTextValues

      public Boolean getQuoteTextValues()
      When set, values of substring-style operators such as "contains" or "startsWith" (including their case-insensitive and negated variants - any operator declaring textMatch) are surrounded with double quotes in the output, so a value containing the words "and" or "or" cannot read as a further clause of the sentence. When unset, values appear unquoted.
      Returns:
      Current quoteTextValues value. Default value is null
    • setSuffix

      public CriteriaOutputSettings setSuffix(String suffix)
      Suffix to be appended to each criterion description.
      Parameters:
      suffix - New suffix value. Default value is null
      Returns:
      CriteriaOutputSettings instance, for chaining setter calls
    • getSuffix

      public String getSuffix()
      Suffix to be appended to each criterion description.
      Returns:
      Current suffix value. Default value is null
    • setTextMatchStyle

      public CriteriaOutputSettings setTextMatchStyle(String textMatchStyle)
      TextMatchStyle to use if converting from a simple criteria. This property, if specified, is passed to convertCriteria to override the default.
      Parameters:
      textMatchStyle - New textMatchStyle value. Default value is null
      Returns:
      CriteriaOutputSettings instance, for chaining setter calls
    • getTextMatchStyle

      public String getTextMatchStyle()
      TextMatchStyle to use if converting from a simple criteria. This property, if specified, is passed to convertCriteria to override the default.
      Returns:
      Current textMatchStyle value. Default value is null