Package com.commercetools.api.models.error

Interface EnumValuesMustMatchError

All Superinterfaces:
ErrorObject
public interface EnumValuesMustMatchError extends ErrorObject

Returned when during an order update of AttributeEnumType or AttributeLocalizedEnumType the new enum values do not match the existing ones.

The error is returned as a failed response to the Change the order of EnumValues and Change the order of LocalizedEnumValues update actions.

Example to create an instance using the builder pattern 

     EnumValuesMustMatchError enumValuesMustMatchError = EnumValuesMustMatchError.builder()
             .message("{message}")
             .build()

  • Field Details

    • ENUM_VALUES_MUST_MATCH

      static final String ENUM_VALUES_MUST_MATCH
      discriminator value for EnumValuesMustMatchError
      See Also:

  • Method Details

    • getCode

      @NotNull @NotNull String getCode()
      Description copied from interface: ErrorObject

      Error identifier.

      Specified by:
      getCode in interface ErrorObject
      Returns:
      code

    • getMessage

      @NotNull @NotNull String getMessage()

      "The given values must be equal to the existing enum values."

      Specified by:
      getMessage in interface ErrorObject
      Returns:
      message

    • setMessage

      void setMessage(String message)

      "The given values must be equal to the existing enum values."

      Specified by:
      setMessage in interface ErrorObject
      Parameters:
      message - value to be set

    • of

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

    • of

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

    • copyDeep

      EnumValuesMustMatchError copyDeep()
      Specified by:
      copyDeep in interface ErrorObject

    • deepCopy

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

    • builder

      static EnumValuesMustMatchErrorBuilder builder()
      builder factory method for EnumValuesMustMatchError
      Returns:
      builder

    • builder

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

    • withEnumValuesMustMatchError

      default <T> T withEnumValuesMustMatchError(Function<EnumValuesMustMatchError,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<EnumValuesMustMatchError> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference