Share this page

com.hp.lft.sdk.apitesting.uft

## Class APITestRunner

- java.lang.Object
- - com.hp.lft.sdk.apitesting.uft.APITestRunner

-     public class APITestRunner
      extends java.lang.Object

  A class intended for running API tests.

- - ### Constructor Summary

    Constructor and Description
    `APITestRunner()`

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `static APITestResult` | `run(java.lang.String testPath)` Runs the specified API Test and returns the test run results. Your API test must have been run in UFT once or compiled before running it with UFT Developer.
    `static APITestResult` | `run(java.lang.String testPath, java.util.Map<java.lang.String,java.lang.Object> inParams)` Runs the specified API test with the specified input parameters. Your API test must have been run in UFT once or compiled before running it with UFT Developer.
    `static APITestResult` | `run(java.lang.String testPath, java.util.Map<java.lang.String,java.lang.Object> inParams, java.lang.String profileName)` Runs the specified API test with the specified input parameters and test profile. Your API test must have been run in UFT once or compiled before running it with UFT Developer.
    `static APITestResult` | `run(java.lang.String testPath, java.lang.String profileName)` Runs the specified API Test with the specified test profile. Your API test must have been run in UFT once or compiled before running it with UFT Developer.

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### APITestRunner

          public APITestRunner()

  - ### Method Detail

    - #### run

          public static APITestResult run(java.lang.String testPath,
                                          java.util.Map<java.lang.String,java.lang.Object> inParams,
                                          java.lang.String profileName)
                                   throws GeneralLeanFtException

      Runs the specified API test with the specified input parameters and test profile.
      Your API test must have been run in UFT once or compiled before running it with UFT Developer.
      Parameters:
        `testPath` - the path to the folder containing the .st test file.
        `inParams` - the input parameters of this test.
        `profileName` - the name of the profile to use for this test. The profiles are created in UFT in each test.
      Returns:
        the run results of this test run.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### run

          public static APITestResult run(java.lang.String testPath,
                                          java.util.Map<java.lang.String,java.lang.Object> inParams)
                                   throws GeneralLeanFtException

      Runs the specified API test with the specified input parameters.
      Your API test must have been run in UFT once or compiled before running it with UFT Developer.
      Parameters:
        `testPath` - the path to the folder containing the .st test file.
        `inParams` - The input parameters of this test.
      Returns:
        The run results of this test run.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### run

          public static APITestResult run(java.lang.String testPath,
                                          java.lang.String profileName)
                                   throws GeneralLeanFtException

      Runs the specified API Test with the specified test profile.
      Your API test must have been run in UFT once or compiled before running it with UFT Developer.
      Parameters:
        `testPath` - the path to the folder containing the .st test file.
        `profileName` - The name of the profile to use for test. The profiles are created in UFT in each test.
      Returns:
        The run results of this test run.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### run

          public static APITestResult run(java.lang.String testPath)
                                   throws GeneralLeanFtException

      Runs the specified API Test and returns the test run results.
      Your API test must have been run in UFT once or compiled before running it with UFT Developer.
      Parameters:
        `testPath` - the path to the folder containing the .st test file.
      Returns:
        the run results of this test run.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

Tips to improve your search results... UFT Developer Java SDK Reference Version 15.0-15.0.2 UFT Developer SDK Reference All View Local Help Center View Online Help Center back Go back in browser history forward Go forward in browser history Remove search highlights next topic Go to next topic previous topic Go to previous topic Print the current topic Version: