Class ShippingVerifyResult


  • public class ShippingVerifyResult
    extends java.lang.Object
    The Response of the /shippingverify endpoint. Describes the result of checking all applicable shipping rules against each line in the transaction.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Boolean getCompliant()
      Getter for compliant Whether every line in the transaction is compliant.
      java.util.ArrayList<FailureCodes> getFailureCodes()
      Getter for failureCodes An enumeration of all the failure codes received across all lines.
      java.lang.String getFailureMessages()
      Getter for failureMessages A detailed description of the result of each of the failed checks made against this transaction, separated by line.
      java.util.ArrayList<java.util.HashMap<java.lang.String,​java.lang.String>> getLines()
      Getter for lines Describes the results of the checks made for each line in the transaction.
      java.lang.String getMessage()
      Getter for message A short description of the result of the compliance check.
      java.lang.String getSuccessMessages()
      Getter for successMessages A detailed description of the result of each of the passed checks made against this transaction, separated by line.
      java.util.ArrayList<java.lang.String> getWarningCodes()
      Getter for warningCodes An enumeration of all the warning codes received across all lines that a determination could not be made for.
      void setCompliant​(java.lang.Boolean value)
      Setter for compliant Whether every line in the transaction is compliant.
      void setFailureCodes​(java.util.ArrayList<FailureCodes> value)
      Setter for failureCodes An enumeration of all the failure codes received across all lines.
      void setFailureMessages​(java.lang.String value)
      Setter for failureMessages A detailed description of the result of each of the failed checks made against this transaction, separated by line.
      void setLines​(java.util.ArrayList<java.util.HashMap<java.lang.String,​java.lang.String>> value)
      Setter for lines Describes the results of the checks made for each line in the transaction.
      void setMessage​(java.lang.String value)
      Setter for message A short description of the result of the compliance check.
      void setSuccessMessages​(java.lang.String value)
      Setter for successMessages A detailed description of the result of each of the passed checks made against this transaction, separated by line.
      void setWarningCodes​(java.util.ArrayList<java.lang.String> value)
      Setter for warningCodes An enumeration of all the warning codes received across all lines that a determination could not be made for.
      java.lang.String toString()
      Returns a JSON string representation of ShippingVerifyResult
      • Methods inherited from class java.lang.Object

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

      • ShippingVerifyResult

        public ShippingVerifyResult()
    • Method Detail

      • getCompliant

        public java.lang.Boolean getCompliant()
        Getter for compliant Whether every line in the transaction is compliant.
      • setCompliant

        public void setCompliant​(java.lang.Boolean value)
        Setter for compliant Whether every line in the transaction is compliant.
      • getMessage

        public java.lang.String getMessage()
        Getter for message A short description of the result of the compliance check.
      • setMessage

        public void setMessage​(java.lang.String value)
        Setter for message A short description of the result of the compliance check.
      • getSuccessMessages

        public java.lang.String getSuccessMessages()
        Getter for successMessages A detailed description of the result of each of the passed checks made against this transaction, separated by line.
      • setSuccessMessages

        public void setSuccessMessages​(java.lang.String value)
        Setter for successMessages A detailed description of the result of each of the passed checks made against this transaction, separated by line.
      • getFailureMessages

        public java.lang.String getFailureMessages()
        Getter for failureMessages A detailed description of the result of each of the failed checks made against this transaction, separated by line.
      • setFailureMessages

        public void setFailureMessages​(java.lang.String value)
        Setter for failureMessages A detailed description of the result of each of the failed checks made against this transaction, separated by line.
      • getFailureCodes

        public java.util.ArrayList<FailureCodes> getFailureCodes()
        Getter for failureCodes An enumeration of all the failure codes received across all lines. Note: AlcoholContentLimitExceeded is included in API versions 2.2 and later.
      • setFailureCodes

        public void setFailureCodes​(java.util.ArrayList<FailureCodes> value)
        Setter for failureCodes An enumeration of all the failure codes received across all lines. Note: AlcoholContentLimitExceeded is included in API versions 2.2 and later.
      • getWarningCodes

        public java.util.ArrayList<java.lang.String> getWarningCodes()
        Getter for warningCodes An enumeration of all the warning codes received across all lines that a determination could not be made for.
      • setWarningCodes

        public void setWarningCodes​(java.util.ArrayList<java.lang.String> value)
        Setter for warningCodes An enumeration of all the warning codes received across all lines that a determination could not be made for.
      • getLines

        public java.util.ArrayList<java.util.HashMap<java.lang.String,​java.lang.String>> getLines()
        Getter for lines Describes the results of the checks made for each line in the transaction.
      • setLines

        public void setLines​(java.util.ArrayList<java.util.HashMap<java.lang.String,​java.lang.String>> value)
        Setter for lines Describes the results of the checks made for each line in the transaction.
      • toString

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