Class ResultsResponse

java.lang.Object
com.tt1.simserver.model.jsonrepresentations.ResultsResponse

public class ResultsResponse extends Object
Representa la respuesta devuelta por el servidor al consultar el historial de resultados de un tablero.
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    Compara esta respuesta con otro objeto para verificar si exponen los mismos resultados.
    Obtiene los datos resultantes con el historial del tablero simulado.
    Indica si los datos de la simulación se obtuvieron correctamente.
    Obtiene el mensaje descriptivo en caso de error durante la búsqueda de los resultados.
    Obtiene el identificador numérico de la simulación a la que pertenecen los resultados.
    int
    Calcula el código numérico para usar esta respuesta en colecciones basadas en hash.
    void
    Establece los datos resultantes con el historial del tablero simulado.
    void
    Actualiza el estado de éxito al recuperar los resultados.
    void
    setErrorMessage(String errorMessage)
    Establece el mensaje de error de la operación de consulta.
    void
    setRequestToken(Integer requestToken)
    Establece el identificador numérico de la simulación a la que pertenecen los resultados.
    Genera una representación en texto con los datos del historial devuelto.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • ResultsResponse

      public ResultsResponse()
  • Method Details

    • getDone

      public Boolean getDone()
      Indica si los datos de la simulación se obtuvieron correctamente.

      Precondición: Ninguna.

      Postcondición: Devuelve verdadero si los resultados están incluidos en esta respuesta, o falso si hubo un fallo al recuperarlos.

      Returns:
      el estado de éxito de la operación.
    • setDone

      public void setDone(Boolean done)
      Actualiza el estado de éxito al recuperar los resultados.

      Precondición: Ninguna.

      Postcondición: El estado de éxito interno se sobreescribe con el valor proporcionado.

      Parameters:
      done - verdadero si la petición fue exitosa, falso en caso contrario.
    • getRequestToken

      public Integer getRequestToken()
      Obtiene el identificador numérico de la simulación a la que pertenecen los resultados.

      Precondición: Ninguna.

      Postcondición: Devuelve el token exacto de la simulación consultada.

      Returns:
      el token numérico de la simulación.
    • setRequestToken

      public void setRequestToken(Integer requestToken)
      Establece el identificador numérico de la simulación a la que pertenecen los resultados.

      Precondición: Ninguna.

      Postcondición: El token interno de la petición se sobreescribe con el valor proporcionado.

      Parameters:
      requestToken - el token numérico.
    • getErrorMessage

      public String getErrorMessage()
      Obtiene el mensaje descriptivo en caso de error durante la búsqueda de los resultados.

      Precondición: Ninguna.

      Postcondición: Devuelve el texto del error, o nulo si los resultados se recuperaron con éxito.

      Returns:
      el texto del mensaje de error, o nulo si no hubo error.
    • setErrorMessage

      public void setErrorMessage(String errorMessage)
      Establece el mensaje de error de la operación de consulta.

      Precondición: Ninguna.

      Postcondición: El mensaje de error interno se actualiza con el texto indicado.

      Parameters:
      errorMessage - el texto del mensaje de error.
    • getData

      public String getData()
      Obtiene los datos resultantes con el historial del tablero simulado.

      Precondición: Ninguna.

      Postcondición: Devuelve una cadena de texto que contiene todos los pasos capturados de la simulación finalizada.

      Returns:
      el historial generado por la simulación.
    • setData

      public void setData(String data)
      Establece los datos resultantes con el historial del tablero simulado.

      Precondición: Ninguna.

      Postcondición: Los datos internos del historial se sobreescriben con el contenido proporcionado.

      Parameters:
      data - la información en texto de la simulación.
    • equals

      public boolean equals(Object o)
      Compara esta respuesta con otro objeto para verificar si exponen los mismos resultados.

      Precondición: Ninguna.

      Postcondición: Devuelve verdadero si el otro objeto es una respuesta idéntica con el mismo token e historial de datos. Devuelve falso en caso contrario.

      Overrides:
      equals in class Object
      Parameters:
      o - el objeto a comparar.
      Returns:
      verdadero si tienen la misma información, falso si difieren.
    • hashCode

      public int hashCode()
      Calcula el código numérico para usar esta respuesta en colecciones basadas en hash.

      Precondición: Ninguna.

      Postcondición: Devuelve un número entero generado a partir del estado, el token y los datos resultantes.

      Overrides:
      hashCode in class Object
      Returns:
      el valor hash calculado.
    • toString

      public String toString()
      Genera una representación en texto con los datos del historial devuelto.

      Precondición: Ninguna.

      Postcondición: Devuelve una cadena de texto multilínea mostrando si fue un éxito y la información contenida en el resultado.

      Overrides:
      toString in class Object
      Returns:
      una representación en formato de texto.