Class ErrorDetail


  • public class ErrorDetail
    extends java.lang.Object
    Message object
    • Constructor Summary

      Constructors 
      Constructor Description
      ErrorDetail()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      ErrorCodeId getCode()
      Getter for code Name of the error or message.
      java.lang.String getDescription()
      Getter for description A more detailed description of the problem referenced by this error message, suitable for display in the contents area of an alert box.
      java.lang.String getFaultCode()
      Getter for faultCode Indicates the SOAP Fault code, if this was related to an error that corresponded to AvaTax SOAP v1 behavior.
      java.lang.String getFaultSubCode()
      Getter for faultSubCode If this is an error from a downstream system (such as Calc) faultSubCode can be used to represent the fault code from that system.
      java.lang.String getHelpLink()
      Getter for helpLink URL to help for this message
      java.lang.String getMessage()
      Getter for message Concise summary of the message, suitable for display in the caption of an alert box.
      java.lang.Integer getNumber()
      Getter for number Unique ID number referring to this error or message.
      java.lang.String getRefersTo()
      Getter for refersTo Item the message refers to, if applicable.
      SeverityLevel getSeverity()
      Getter for severity Severity of the message
      void setCode​(ErrorCodeId value)
      Setter for code Name of the error or message.
      void setDescription​(java.lang.String value)
      Setter for description A more detailed description of the problem referenced by this error message, suitable for display in the contents area of an alert box.
      void setFaultCode​(java.lang.String value)
      Setter for faultCode Indicates the SOAP Fault code, if this was related to an error that corresponded to AvaTax SOAP v1 behavior.
      void setFaultSubCode​(java.lang.String value)
      Setter for faultSubCode If this is an error from a downstream system (such as Calc) faultSubCode can be used to represent the fault code from that system.
      void setHelpLink​(java.lang.String value)
      Setter for helpLink URL to help for this message
      void setMessage​(java.lang.String value)
      Setter for message Concise summary of the message, suitable for display in the caption of an alert box.
      void setNumber​(java.lang.Integer value)
      Setter for number Unique ID number referring to this error or message.
      void setRefersTo​(java.lang.String value)
      Setter for refersTo Item the message refers to, if applicable.
      void setSeverity​(SeverityLevel value)
      Setter for severity Severity of the message
      java.lang.String toString()
      Returns a JSON string representation of ErrorDetail
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • ErrorDetail

        public ErrorDetail()
    • Method Detail

      • getCode

        public ErrorCodeId getCode()
        Getter for code Name of the error or message.
      • setCode

        public void setCode​(ErrorCodeId value)
        Setter for code Name of the error or message.
      • getNumber

        public java.lang.Integer getNumber()
        Getter for number Unique ID number referring to this error or message.
      • setNumber

        public void setNumber​(java.lang.Integer value)
        Setter for number Unique ID number referring to this error or message.
      • getMessage

        public java.lang.String getMessage()
        Getter for message Concise summary of the message, suitable for display in the caption of an alert box.
      • setMessage

        public void setMessage​(java.lang.String value)
        Setter for message Concise summary of the message, suitable for display in the caption of an alert box.
      • getDescription

        public java.lang.String getDescription()
        Getter for description A more detailed description of the problem referenced by this error message, suitable for display in the contents area of an alert box.
      • setDescription

        public void setDescription​(java.lang.String value)
        Setter for description A more detailed description of the problem referenced by this error message, suitable for display in the contents area of an alert box.
      • getFaultCode

        public java.lang.String getFaultCode()
        Getter for faultCode Indicates the SOAP Fault code, if this was related to an error that corresponded to AvaTax SOAP v1 behavior.
      • setFaultCode

        public void setFaultCode​(java.lang.String value)
        Setter for faultCode Indicates the SOAP Fault code, if this was related to an error that corresponded to AvaTax SOAP v1 behavior.
      • getFaultSubCode

        public java.lang.String getFaultSubCode()
        Getter for faultSubCode If this is an error from a downstream system (such as Calc) faultSubCode can be used to represent the fault code from that system.
      • setFaultSubCode

        public void setFaultSubCode​(java.lang.String value)
        Setter for faultSubCode If this is an error from a downstream system (such as Calc) faultSubCode can be used to represent the fault code from that system.
      • getHelpLink

        public java.lang.String getHelpLink()
        Getter for helpLink URL to help for this message
      • setHelpLink

        public void setHelpLink​(java.lang.String value)
        Setter for helpLink URL to help for this message
      • getRefersTo

        public java.lang.String getRefersTo()
        Getter for refersTo Item the message refers to, if applicable. This is used to indicate a missing or incorrect value.
      • setRefersTo

        public void setRefersTo​(java.lang.String value)
        Setter for refersTo Item the message refers to, if applicable. This is used to indicate a missing or incorrect value.
      • getSeverity

        public SeverityLevel getSeverity()
        Getter for severity Severity of the message
      • setSeverity

        public void setSeverity​(SeverityLevel value)
        Setter for severity Severity of the message
      • toString

        public java.lang.String toString()
        Returns a JSON string representation of ErrorDetail
        Overrides:
        toString in class java.lang.Object