Package com.commercetools.api.models.search

Interface SearchFullTextValue

All Superinterfaces:
SearchQueryExpressionValue
public interface SearchFullTextValue extends SearchQueryExpressionValue
SearchFullTextValue
Example to create an instance using the builder pattern 

     SearchFullTextValue searchFullTextValue = SearchFullTextValue.builder()
             .field("{field}")
             .build()

  • Method Details

    • getValue

      @NotNull @NotNull Object getValue()
      Returns:
      value

    • getLanguage

      String getLanguage()

      String value specifying linguistic and regional preferences using the IETF language tag format, as described in BCP 47. The format combines language, script, and region using hyphen-separated subtags. For example: en, en-US, zh-Hans-SG.

      Returns:
      language

    • getMustMatch

      SearchMatchType getMustMatch()
      Returns:
      mustMatch

    • setValue

      void setValue(Object value)
      set value
      Parameters:
      value - value to be set

    • setLanguage

      void setLanguage(String language)

      String value specifying linguistic and regional preferences using the IETF language tag format, as described in BCP 47. The format combines language, script, and region using hyphen-separated subtags. For example: en, en-US, zh-Hans-SG.

      Parameters:
      language - value to be set

    • setMustMatch

      void setMustMatch(SearchMatchType mustMatch)
      set mustMatch
      Parameters:
      mustMatch - value to be set

    • of

      static SearchFullTextValue of()
      factory method
      Returns:
      instance of SearchFullTextValue

    • of

      static SearchFullTextValue of(SearchFullTextValue template)
      factory method to create a shallow copy SearchFullTextValue
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • deepCopy

      @Nullable static SearchFullTextValue deepCopy(@Nullable SearchFullTextValue template)
      factory method to create a deep copy of SearchFullTextValue
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static SearchFullTextValueBuilder builder()
      builder factory method for SearchFullTextValue
      Returns:
      builder

    • builder

      static SearchFullTextValueBuilder builder(SearchFullTextValue template)
      create builder for SearchFullTextValue instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withSearchFullTextValue

      default <T> T withSearchFullTextValue(Function<SearchFullTextValue,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<SearchFullTextValue> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference