Record Class GenerateResponse

java.lang.Object
java.lang.Record
com.pain001.sdk.GenerateResponse
Record Components:
success - whether the XML was generated
message - a human-readable result line
filename - the suggested download name, or null
xml - the generated XML document, or null when generation failed
validationErrors - row-level validation errors, when validation failed
schemeViolations - scheme-rulebook violations, when scheme validation failed

public record GenerateResponse(boolean success, String message, String filename, String xml, List<RowError> validationErrors, List<com.fasterxml.jackson.databind.JsonNode> schemeViolations) extends Record
POST /api/v1/ui/generate (the server's UiGenerateResponse).
  • Constructor Details

    • GenerateResponse

      public GenerateResponse(boolean success, String message, String filename, String xml, List<RowError> validationErrors, List<com.fasterxml.jackson.databind.JsonNode> schemeViolations)
      Copies the lists so the record stays immutable.
  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object
    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object
    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.
    • success

      public boolean success()
      Returns the value of the success record component.
      Returns:
      the value of the success record component
    • message

      public String message()
      Returns the value of the message record component.
      Returns:
      the value of the message record component
    • filename

      public String filename()
      Returns the value of the filename record component.
      Returns:
      the value of the filename record component
    • xml

      public String xml()
      Returns the value of the xml record component.
      Returns:
      the value of the xml record component
    • validationErrors

      public List<RowError> validationErrors()
      Returns the value of the validationErrors record component.
      Returns:
      the value of the validationErrors record component
    • schemeViolations

      public List<com.fasterxml.jackson.databind.JsonNode> schemeViolations()
      Returns the value of the schemeViolations record component.
      Returns:
      the value of the schemeViolations record component