Package eu.ccvlab.mapi.core.api

Interface OpiDEApi

public interface OpiDEApi

  • Method Details

    • initialisation

      default void initialisation(ExternalTerminal terminal, TerminalDelegate delegate)
      Initialisation.
      Parameters:
      terminal - Connection information to reach the terminal, containing IP address, ports, terminalType with opi-language and socket mode.
      delegate - Callback hook towards the caller to inform regarding success/status/failure

    • reconciliationWithClosure

      @Deprecated default void reconciliationWithClosure(ExternalTerminal terminal, TerminalDelegate delegate)
      Deprecated.
      use TerminalApi.periodClosing(ExternalTerminal, TerminalDelegate)
      Reconciliation with closure.
      Parameters:
      terminal - Connection information to reach the terminal, containing IP address, ports, terminalType with opi-language and socket mode.
      delegate - Callback hook towards the caller to inform regarding success/status/failure

    • startup

      default void startup(ExternalTerminal terminal, TerminalDelegate delegate)
      Startup the OPI-DE service
      Parameters:
      terminal - Connection information to reach the terminal, containing IP address, ports, terminalType with opi-language and socket mode.
      delegate - Callback hook towards the caller to inform regarding success/status/failure

    • cardRead

      default void cardRead(ExternalTerminal terminal, CardReadDelegate delegate, CardReadRequest cardReadRequest)
      Execute an OPI-DE card read
      Parameters:
      terminal - Connection information to reach the terminal, containing IP address, ports, terminalType with opi-language and socket mode.
      delegate - Callback hook towards the caller to inform regarding success/status/failure
      cardReadRequest - CardReadRequest contains all the different options you can configure for a card read

    • cardReaderStatus

      default void cardReaderStatus(ExternalTerminal terminal, CardReaderStatusDelegate delegate)
      OPI-DE specific Fetch the status of the card reader
      Parameters:
      terminal - Connection information to reach the terminal, containing IP address, ports, terminalType with opi-language and socket mode.
      delegate - Callback hook towards the caller to inform regarding success/status/failure

    • paymentAfterCardRead

      default void paymentAfterCardRead(ExternalTerminal terminal, Payment payment, PaymentDelegate delegate)
      Execute an OPI-DE payment after card read. All interaction from the terminal out will be handed to the payment issuer using the PaymentDelegate.
      Parameters:
      terminal - Connection information to reach the terminal, containing IP address, ports, terminalType with opi-language and socket mode.
      payment - Defines the payment being processed using card read result
      delegate - Callback hook towards the caller to inform regarding success/status/failure

    • callTMS

      default void callTMS(ExternalTerminal terminal, TerminalDelegate delegate, String jobName)
      OPI-DE specific CallTMS
      Parameters:
      terminal - Connection information to reach the terminal, containing IP address, ports, terminalType with opi-language and socket mode.
      delegate - Callback hook towards the caller to inform regarding success/status/failure
      jobName - JobName that can be passed with the callTMS command

    • checkPassword

      default void checkPassword(ExternalTerminal terminal, TerminalDelegate delegate)
      OPI-DE specific CheckPassword
      Parameters:
      terminal - Connection information to reach the terminal, containing IP address, ports, terminalType with opi-language and socket mode.
      delegate - Callback hook towards the caller to inform regarding success/status/failure

    • factoryReset

      @Deprecated default void factoryReset(ExternalTerminal terminal, TerminalDelegate delegate)
      Deprecated.
      use resetToFactorySettings(ExternalTerminal, TerminalDelegate)
      OPI-DE specific Factory Reset
      Parameters:
      terminal - Connection information to reach the terminal, containing IP address, ports, terminalType with opi-language and socket mode.
      delegate - Callback hook towards the caller to inform regarding success/status/failure

    • resetToFactorySettings

      default void resetToFactorySettings(ExternalTerminal terminal, TerminalDelegate delegate)
      OPI-DE specific Factory Reset
      Parameters:
      terminal - Connection information to reach the terminal, containing IP address, ports, terminalType with opi-language and socket mode.
      delegate - Callback hook towards the caller to inform regarding success/status/failure

    • startServiceMenu

      default void startServiceMenu(ExternalTerminal terminal, TerminalDelegate delegate)
      OPI-DE specific Start ServiceMenu
      Parameters:
      terminal - Connection information to reach the terminal, containing IP address, ports, terminalType with opi-language and socket mode.
      delegate - Callback hook towards the caller to inform regarding success/status/failure

    • oamServerApplications

      default void oamServerApplications(ExternalTerminal terminal, TerminalDelegate delegate)
      OPI-DE specific OAMServerList
      Parameters:
      terminal - Connection information to reach the terminal, containing IP address, ports, terminalType with opi-language and socket mode.
      delegate - Callback hook towards the caller to inform regarding success/status/failure

    • terminalOperation

      default void terminalOperation(ExternalTerminal terminal, TerminalDelegate delegate, TerminalOperationType terminalOperationType)
      OPI-DE specific Terminal Operation
      Parameters:
      terminal - Connection information to reach the terminal, containing IP address, ports, terminalType with opi-language and socket mode.
      delegate - Callback hook towards the caller to inform regarding success/status/failure
      terminalOperationType - Type of diagnosis that needs to be started

    • terminalAdministrationOperation

      default void terminalAdministrationOperation(ExternalTerminal terminal, TerminalDelegate delegate, TerminalAdministrationOperationType terminalAdministrationOperationType)
      OPI-DE specific Terminal Operation
      Parameters:
      terminal - Connection information to reach the terminal, containing IP address, ports, terminalType with opi-language and socket mode.
      delegate - Callback hook towards the caller to inform regarding success/status/failure
      terminalAdministrationOperationType - Type of terminalAdministrationOperation that needs to be started

    • terminalCommand

      default void terminalCommand(ExternalTerminal terminal, TerminalDelegate terminalDelegate, TerminalCommandRequest terminalCommandRequest, Agent agent)

    • elmeVersionInfo

      default void elmeVersionInfo(ExternalTerminal terminal, TerminalDelegate terminalDelegate)

    • retrieveTerminalMenuItem

      default void retrieveTerminalMenuItem(ExternalTerminal terminal, TerminalDelegate terminalDelegate, String terminalMenuItemPath)