com.hp.lft.sdk.sap.gui

Interface GuiSession

    • Method Detail

      • getActiveWindow

        java.lang.String getActiveWindow()
                                  throws GeneralLeanFtException
        Returns the name of the window in focus.
        Returns:
        the name of the window.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.
      • getApplicationServer

        java.lang.String getApplicationServer()
                                       throws GeneralLeanFtException
        Returns the name of the application server. Applies only when the connection specifies an application server and is not using load balancing.
        Returns:
        the name of the application server.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.
      • getFlushes

        long getFlushes()
                 throws GeneralLeanFtException
        Returns the number of flushes or passes of data during server communication to the client.
        Returns:
        the number of flushes or passes.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.
      • getGroup

        java.lang.String getGroup()
                           throws GeneralLeanFtException
        Returns the login group information. Applies only when connection is using load balancing.
        Returns:
        the login group information.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.
      • getInterpretationTime

        long getInterpretationTime()
                            throws GeneralLeanFtException
        Returns the time it takes for the client to interpret the information received from the server, in milliseconds.
        Returns:
        milliseconds.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.
      • getMessageServer

        java.lang.String getMessageServer()
                                   throws GeneralLeanFtException
        Returns the name of the message server. Applies only when connection is using load balancing.
        Returns:
        the name of the message server.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.
      • getRoundTrips

        long getRoundTrips()
                    throws GeneralLeanFtException
        Returns the number of communications between client and server while the client is locked and waiting for data from the server.
        Returns:
        the number of communications.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.
      • getSystemName

        java.lang.String getSystemName()
                                throws GeneralLeanFtException
        Returns the name of the SAP system.
        Returns:
        the name of the SAP system.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.
      • getSystemNumber

        long getSystemNumber()
                      throws GeneralLeanFtException
        Returns the system number. Applies only when connection specifies an application server and is not using load balancing.
        Returns:
        the system number.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.
      • getTransaction

        java.lang.String getTransaction()
                                 throws GeneralLeanFtException
        Returns the transaction the user is executing.
        Returns:
        the transaction.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.
      • getScreenNumber

        long getScreenNumber()
                      throws GeneralLeanFtException
        Returns the number of the screen that is displayed.
        Returns:
        the screen number.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.
      • getProgram

        java.lang.String getProgram()
                             throws GeneralLeanFtException
        Returns the name of the SAP source program that is executing.
        Returns:
        the name of the program.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.
      • sync

        void sync(long timeOut)
           throws GeneralLeanFtException
        Suspends execution until the SAP GUI for Windows session is available or until timed out.
        After time-out, the test run continues regardless of the session status.
        You can use this method when invoking a new session from an existing session or when moving from a session that is open on one server to a new session on a different server.
        Parameters:
        timeOut - milliseconds.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.
      • close

        void close()
            throws GeneralLeanFtException
        Closes the SAP GUI for Windows session without displaying a warning message.
        You can invoke this method at the end of an action or a test iteration to close sessions that were opened during the test run. This ensures that each iteration begins with the same number of open SAP Gui for Windows sessions.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.
      • reset

        void reset()
            throws GeneralLeanFtException
        Navigates to the session initial screen. We recommend using this method to ensure that tests are rerun from the initial screen of the session.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.
      • reset

        void reset(java.lang.String transactionCode)
            throws GeneralLeanFtException
        Navigates to the specified transaction.
        Parameters:
        transactionCode - the transaction.
        Throws:
        GeneralLeanFtException - if an error occurs during execution.