Package mx.com.sw.entities

Class IResponse

java.lang.Object
mx.com.sw.entities.IResponse
Direct Known Subclasses:
AccountBalanceResponse, AccountInfoResponse, AuthenticationResponse, CancelationResponse, StampResponseV1, StampResponseV2, StampResponseV3, StampResponseV4
public abstract class IResponse
extends java.lang.Object
IResponse Está clase sirve de base para las respuestas que se utilizan a través de la librería.
Since:
2020-08-01
Version:
0.0.0.1
Author:
Juan Gamez

  • Constructor Summary

    Constructors 
    Constructor Description
    IResponse​(java.lang.String status, java.lang.String message, java.lang.String messageDetail)
    Constructor parametrizado.

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getMessage()
    Obtiene el mensaje de error obtenido.
    java.lang.String getMessageDetail()
    Obtiene los detalles acerca del mensaje de error.
    java.lang.String getStatus()
    Obtiene el status de la solicitud.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • IResponse

      public IResponse​(java.lang.String status, java.lang.String message, java.lang.String messageDetail)
      Constructor parametrizado.
      Parameters:
      status - estatus de la petición, valores: "status" y "error".
      message - mensaje arrojado en la API.
      messageDetail - detalles del mensaje de la API.

  • Method Details

    • getStatus

      public java.lang.String getStatus()
      Obtiene el status de la solicitud. Solo puede ser "success" o "error". En caso de "success" puede consultar el campo "data". En caso de "error", consultar "getMessage" y "getMessageDetail".
      Returns:
      String

    • getMessage

      public java.lang.String getMessage()
      Obtiene el mensaje de error obtenido. Nota: Este valor generalmente solo existe cunado la solicitud termino con status "error".
      Returns:
      String

    • getMessageDetail

      public java.lang.String getMessageDetail()
      Obtiene los detalles acerca del mensaje de error. Útil cuando el mensaje de error no es muy claro. Nota: Este valor generalmente solo existe cunado la solicitud termino con status "error". Nota: Puede ser null.
      Returns:
      String