Package com.commercetools.api.models.search

Interface SearchSortMode

All Superinterfaces:
JsonEnum
All Known Implementing Classes:
SearchSortMode.SearchSortModeEnum
public interface SearchSortMode extends JsonEnum

For set-type fields, only a single value of the set is taken into account for sorting. The sort mode determines whether the minimum or maximum value, or a calculated statistical value should be used as sorting value.

  • Field Details

    • MIN

      static final SearchSortMode MIN

      Use the minimum of all available values.

    • MAX

      static final SearchSortMode MAX

      Use the maximum of all available values.

    • AVG

      static final SearchSortMode AVG

      Use the average of all available values.

    • SUM

      static final SearchSortMode SUM

      Use the sum of all available values.

  • 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 SearchSortMode findEnum(String value)
      factory method for a enum value of SearchSortMode 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<SearchSortMode> 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 SearchSortMode[] values()
      possible enum values
      Returns:
      array of possible enum values