Package com.commercetools.api.models.error

Interface EnumKeyDoesNotExistError

All Superinterfaces:
ErrorObject
public interface EnumKeyDoesNotExistError extends ErrorObject

Returned when an AttributeEnumType or AttributeLocalizedEnumType already contains a value with the given key.

The error is returned as a failed response to the Change the key of an EnumValue update action.

Example to create an instance using the builder pattern 

     EnumKeyDoesNotExistError enumKeyDoesNotExistError = EnumKeyDoesNotExistError.builder()
             .message("{message}")
             .conflictingEnumKey("{conflictingEnumKey}")
             .conflictingAttributeName("{conflictingAttributeName}")
             .build()

  • Field Details

    • ENUM_KEY_DOES_NOT_EXIST

      static final String ENUM_KEY_DOES_NOT_EXIST
      discriminator value for EnumKeyDoesNotExistError
      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 $fieldName field definition does not contain an enum value with the key $enumKey."

      Specified by:
      getMessage in interface ErrorObject
      Returns:
      message

    • getConflictingEnumKey

      @NotNull @NotNull String getConflictingEnumKey()

      Conflicting enum key.

      Returns:
      conflictingEnumKey

    • getConflictingAttributeName

      @NotNull @NotNull String getConflictingAttributeName()

      Name of the conflicting Attribute.

      Returns:
      conflictingAttributeName

    • setMessage

      void setMessage(String message)

      "The $fieldName field definition does not contain an enum value with the key $enumKey."

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

    • setConflictingEnumKey

      void setConflictingEnumKey(String conflictingEnumKey)

      Conflicting enum key.

      Parameters:
      conflictingEnumKey - value to be set

    • setConflictingAttributeName

      void setConflictingAttributeName(String conflictingAttributeName)

      Name of the conflicting Attribute.

      Parameters:
      conflictingAttributeName - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static EnumKeyDoesNotExistErrorBuilder builder()
      builder factory method for EnumKeyDoesNotExistError
      Returns:
      builder

    • builder

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

    • withEnumKeyDoesNotExistError

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