Package com.commercetools.api.models.search

Interface SearchFieldType

All Superinterfaces:
JsonEnum
All Known Implementing Classes:
SearchFieldType.SearchFieldTypeEnum
public interface SearchFieldType extends JsonEnum

Possible values for the fieldType property on query expressions indicating the data type of the field.

  • Field Details

    • BOOLEAN

      static final SearchFieldType BOOLEAN

      For Boolean fields and AttributeBooleanType Attributes.

    • TEXT

      static final SearchFieldType TEXT

      For string fields and AttributeTextType Attributes.

    • LTEXT

      static final SearchFieldType LTEXT

      For LocalizedString fields and AttributeLocalizableTextType Attributes.

    • ENUM

      static final SearchFieldType ENUM

      For enum fields and AttributeEnumType Attributes.

    • LENUM

      static final SearchFieldType LENUM

      For localized enum fields and AttributeLocalizedEnumType Attributes.

    • NUMBER

      static final SearchFieldType NUMBER

      For number fields and AttributeNumberType Attributes.

    • MONEY

      static final SearchFieldType MONEY

      For Money fields and AttributeMoneyType Attributes.

    • DATE

      static final SearchFieldType DATE

      For Date fields and AttributeDateType Attributes.

    • DATETIME

      static final SearchFieldType DATETIME

      For DateTime fields and AttributeDateTimeType Attributes.

    • TIME

      static final SearchFieldType TIME

      For Time fields and AttributeTimeType Attributes.

    • REFERENCE

      static final SearchFieldType REFERENCE

      For Reference fields and AttributeReferenceType Attributes.

    • SET_BOOLEAN

      static final SearchFieldType SET_BOOLEAN

      For Set of Boolean fields and AttributeSetType of boolean Attributes.

    • SET_TEXT

      static final SearchFieldType SET_TEXT

      For Set of string fields and AttributeSetType of text Attributes.

    • SET_LTEXT

      static final SearchFieldType SET_LTEXT

      For Set of LocalizedString fields and AttributeSetType of ltext Attributes.

    • SET_ENUM

      static final SearchFieldType SET_ENUM

      For Set of enum fields and AttributeSetType of enum Attributes.

    • SET_LENUM

      static final SearchFieldType SET_LENUM

      For Set of localized enum fields and AttributeSetType of lenum Attributes.

    • SET_NUMBER

      static final SearchFieldType SET_NUMBER

      For Set of number fields and AttributeSetType of number Attributes.

    • SET_MONEY

      static final SearchFieldType SET_MONEY

      For Set of Money fields and AttributeSetType of money Attributes.

    • SET_DATE

      static final SearchFieldType SET_DATE

      For Set of Date fields and AttributeSetType of date Attributes.

    • SET_DATETIME

      static final SearchFieldType SET_DATETIME

      For Set of DateTime fields and AttributeSetType of datetime Attributes.

    • SET_TIME

      static final SearchFieldType SET_TIME

      For Set of Time fields and AttributeSetType of time Attributes.

    • SET_REFERENCE

      static final SearchFieldType SET_REFERENCE

      For Set of Reference fields and AttributeSetType of reference Attributes.

  • Method Details

    • getJsonName

      String getJsonName()
      the JSON value
      Specified by:
      getJsonName in interface JsonEnum
      Returns:
      json value

    • name

      String name()
      the enum value
      Specified by:
      name in interface JsonEnum
      Returns:
      name

    • toString

      String toString()
      convert value to string
      Specified by:
      toString in interface JsonEnum
      Overrides:
      toString in class Object
      Returns:
      string representation

    • findEnum

      static SearchFieldType findEnum(String value)
      factory method for a enum value of SearchFieldType if no enum has been found an anonymous instance will be created
      Parameters:
      value - the enum value to be wrapped
      Returns:
      enum instance

    • findEnumViaJsonName

      static Optional<SearchFieldType> findEnumViaJsonName(String jsonName)
      method to find enum using the JSON value
      Parameters:
      jsonName - the json value to be wrapped
      Returns:
      optional of enum instance

    • values

      static SearchFieldType[] values()
      possible enum values
      Returns:
      array of possible enum values