Interface AttributeNameDoesNotExistError

All Superinterfaces:
ErrorObject

public interface AttributeNameDoesNotExistError extends ErrorObject

Returned when an AttributeDefinition does not exist for an Attribute name.

The error is returned as a failed response to the Change AttributeDefinition Name update action.


Example to create an instance using the builder pattern

     AttributeNameDoesNotExistError attributeNameDoesNotExistError = AttributeNameDoesNotExistError.builder()
             .message("{message}")
             .invalidAttributeName("{invalidAttributeName}")
             .build()
 
  • Field Details

    • ATTRIBUTE_NAME_DOES_NOT_EXIST

      static final String ATTRIBUTE_NAME_DOES_NOT_EXIST
      discriminator value for AttributeNameDoesNotExistError
      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()

      "Attribute definition for $attributeName does not exist on type $typeName."

      Specified by:
      getMessage in interface ErrorObject
      Returns:
      message
    • getInvalidAttributeName

      @NotNull @NotNull String getInvalidAttributeName()

      Non-existent Attribute name.

      Returns:
      invalidAttributeName
    • setMessage

      void setMessage(String message)

      "Attribute definition for $attributeName does not exist on type $typeName."

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

      void setInvalidAttributeName(String invalidAttributeName)

      Non-existent Attribute name.

      Parameters:
      invalidAttributeName - value to be set
    • of

      factory method
      Returns:
      instance of AttributeNameDoesNotExistError
    • of

      factory method to create a shallow copy AttributeNameDoesNotExistError
      Parameters:
      template - instance to be copied
      Returns:
      copy instance
    • deepCopy

      factory method to create a deep copy of AttributeNameDoesNotExistError
      Parameters:
      template - instance to be copied
      Returns:
      copy instance
    • builder

      builder factory method for AttributeNameDoesNotExistError
      Returns:
      builder
    • builder

      create builder for AttributeNameDoesNotExistError instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder
    • withAttributeNameDoesNotExistError

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