Package de.hybris.platform.b2ctelcotmfresources.v4.dto

Class Error

java.lang.Object
de.hybris.platform.b2ctelcotmfresources.v4.dto.Error
public class Error extends Object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)

  • Constructor Details

    • Error

      public Error()

  • Method Details

    • code

      public Error code(String code)

    • getCode

      @NotNull public @NotNull String getCode()
      Application relevant detail, defined in the API or a common list.
      Returns:
      code

    • setCode

      public void setCode(String code)

    • reason

      public Error reason(String reason)

    • getReason

      @NotNull public @NotNull String getReason()
      Explanation of the reason for the error which can be shown to a client user.
      Returns:
      reason

    • setReason

      public void setReason(String reason)

    • message

      public Error message(String message)

    • getMessage

      public String getMessage()
      More details and corrective actions related to the error which can be shown to a client user.
      Returns:
      message

    • setMessage

      public void setMessage(String message)

    • status

      public Error status(String status)

    • getStatus

      public String getStatus()
      HTTP Error code extension
      Returns:
      status

    • setStatus

      public void setStatus(String status)

    • referenceError

      public Error referenceError(String referenceError)

    • getReferenceError

      public String getReferenceError()
      URI of documentation describing the error.
      Returns:
      referenceError

    • setReferenceError

      public void setReferenceError(String referenceError)

    • atBaseType

      public Error atBaseType(String atBaseType)

    • getAtBaseType

      public String getAtBaseType()
      When sub-classing, this defines the super-class.
      Returns:
      atBaseType

    • setAtBaseType

      public void setAtBaseType(String atBaseType)

    • atSchemaLocation

      public Error atSchemaLocation(String atSchemaLocation)

    • getAtSchemaLocation

      public String getAtSchemaLocation()
      A URI to a JSON-Schema file that defines additional attributes and relationships
      Returns:
      atSchemaLocation

    • setAtSchemaLocation

      public void setAtSchemaLocation(String atSchemaLocation)

    • atType

      public Error atType(String atType)

    • getAtType

      public String getAtType()
      When sub-classing, this defines the sub-class entity name.
      Returns:
      atType

    • setAtType

      public void setAtType(String atType)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object