Package br.com.setis.pgweblib.entidades

Interface TransactionListener

public interface TransactionListener
Listener a ser implementado pela automação comercial durante a execução de uma transação PGWebLib.executeTransaction().

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    onDisplayMessage(String message)
    Callback invocado quando for necessária a exibição de uma mensagem de notificação, por exemplo, "PROCESSANDO".
    A aplicação não deve blocar a execução deste método: deve apenas fazer a exibição e retornar imediatamente.
    void
    onDisplayQRCode(String qrCodeContent, String prompt)
    Callback invocado quando for necessária a exibição de um QR-Code, para captura.
    A aplicação não deve blocar a execução deste método: deve apenas fazer a exibição e retornar imediatamente, para que o processamento da leitura seja corretamente efetuado entre o servidor e o ponto de captura.
    boolean
    onMoreData(GetData[] getDataParams)
    Caso durante a excecução de uma transação, algum dado adicional precise ser informado, este callback será chamado com os parâmetros da captura a serem efetuados, conforme a especificação da PGWebLib.
    String
    onMoreDataGetString(GetData[] getDataParams)
    Caso durante a execução de uma Opereção algum dado adicional precise ser retornado, este callback será chamado com os parâmetros da captura a serem efetuados, conforme a especificação da PGWebLib.
    PinpadListener
    onPinpadCommand(int commandId, boolean allowTyping, String previousMsg)
    Caso seja necessária uma captura no PIN-Pad durante uma transação, este callback será invocado para que a automação comercial registre um listener para ser notificada do estado da captura.
    Diferentemente da PGWebLib tradicional, a automação não precisa identificar o comando e fazer sua execução de acordo: tudo ocorrerá de maneira transparente, com todos os tratamentos necessários sendo realizados pela biblioteca.
    void
    onTransactionFinished(int returnCode)
    Callback invocado quando a transação for finalizada, seja bem-sucedida ou não.
    String
    onTypedData(GetData getData)
    Captura entrada digitada.

  • Method Details

    • onMoreData

      boolean onMoreData(GetData[] getDataParams)
      Caso durante a excecução de uma transação, algum dado adicional precise ser informado, este callback será chamado com os parâmetros da captura a serem efetuados, conforme a especificação da PGWebLib.
      Parameters:
      getDataParams - Lista de estruturas GetData, contendo os parâmetros a serem capturados.
      Returns:
      Se true, indica que a captura foi feita com sucesso. Caso false, a captura não foi realizada (tipicamente cancelada pelo operador). A transação não deve prosseguir.

    • onMoreDataGetString

      String onMoreDataGetString(GetData[] getDataParams)
      Caso durante a execução de uma Opereção algum dado adicional precise ser retornado, este callback será chamado com os parâmetros da captura a serem efetuados, conforme a especificação da PGWebLib.
      Parameters:
      getDataParams - Lista de estruturas GetData, contendo os parâmetros a serem capturados.
      Returns:
      Se true, indica que a captura foi feita com sucesso. Caso false, a captura não foi realizada (tipicamente cancelada pelo operador). A transação não deve prosseguir.

    • onPinpadCommand

      PinpadListener onPinpadCommand(int commandId, boolean allowTyping, String previousMsg)
      Caso seja necessária uma captura no PIN-Pad durante uma transação, este callback será invocado para que a automação comercial registre um listener para ser notificada do estado da captura.
      Diferentemente da PGWebLib tradicional, a automação não precisa identificar o comando e fazer sua execução de acordo: tudo ocorrerá de maneira transparente, com todos os tratamentos necessários sendo realizados pela biblioteca.
      Parameters:
      commandId - ID do tipo de captura que está sendo realizado no PIN-Pad (meramente informativo).
      allowTyping - Indica se é permitida a captura digitada do cartão. Relevante somente se commandId == PWDAT_CARDINF.
      previousMsg - Mensagem a ser exibida ANTES da captura.
      Returns:
      Implementação de PinpadListener efetuada pela automação, para notificação do dado.
      See Also:

    • onTypedData

      String onTypedData(GetData getData)
      Captura entrada digitada.
      Parameters:
      getData - estrutura GetData, contendo os parâmetros a serem capturados.
      Returns:
      String contendo o valor capturado sem máscara.

    • onDisplayMessage

      void onDisplayMessage(String message)
      Callback invocado quando for necessária a exibição de uma mensagem de notificação, por exemplo, "PROCESSANDO".
      A aplicação não deve blocar a execução deste método: deve apenas fazer a exibição e retornar imediatamente.
      Parameters:
      message - Mensagem para ser exibida.

    • onDisplayQRCode

      void onDisplayQRCode(String qrCodeContent, String prompt)
      Callback invocado quando for necessária a exibição de um QR-Code, para captura.
      A aplicação não deve blocar a execução deste método: deve apenas fazer a exibição e retornar imediatamente, para que o processamento da leitura seja corretamente efetuado entre o servidor e o ponto de captura.
      Parameters:
      qrCodeContent - Conteúdo do QR-Code a ser exibido na tela.
      prompt - Mensagem para ser exibida junto do QR-Code, na captura.

    • onTransactionFinished

      void onTransactionFinished(int returnCode)
      Callback invocado quando a transação for finalizada, seja bem-sucedida ou não.
      Parameters:
      returnCode - Erro de execução (ver "10. Códigos de retorno", página 75 - especificação PGWebLib). Uma mensagem de erro pode ser obtida através da função PGWebLib.getResult(Short PWINFO_RESULTMSG).