Share this page

com.hp.lft.report

## Interface ReportConfiguration

- All Known Implementing Classes:
    ModifiableReportConfiguration

      public interface ReportConfiguration

  Report configuration interface.

- - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `java.lang.String` | `getDescription()` Returns the UFT Developer report description.
    `java.lang.String` | `getReportFolder()` Returns the name of the folder where the UFT Developer report is generated.
    `ReportLevel` | `getReportLevel()` Returns the level of events to be reported.
    `CaptureLevel` | `getSnapshotsLevel()` The snapshot capture level used to generate the UFT Developer report.
    `java.lang.String` | `getTargetDirectory()` Returns the root directory where report folders are generated.
    `java.lang.String` | `getTitle()` Returns the UFT Developer report title.
    `boolean` | `isOverrideExisting()` Indicates whether the existing report files will be overridden.
    `boolean` | `isReportEnabled()` Indicates if the reporting is enabled.

- - ### Method Detail

    - #### isReportEnabled

          boolean isReportEnabled()

      Indicates if the reporting is enabled. If false, the report won't be initialized and generated at all. Default = true
      Returns:
        true if the reporting is enabled

    - #### getReportFolder

          java.lang.String getReportFolder()

      Returns the name of the folder where the UFT Developer report is generated. Default = RunResults.
      Returns:
        name of the report folder.

    - #### getTitle

          java.lang.String getTitle()

      Returns the UFT Developer report title. Default = Run Results.
      Returns:
        the title of the report.

    - #### getDescription

          java.lang.String getDescription()

      Returns the UFT Developer report description. The description appears directly below the title in the UFT Developer report. By default, the description is empty.
      Returns:
        description of the Report.

    - #### getTargetDirectory

          java.lang.String getTargetDirectory()

      Returns the root directory where report folders are generated. Default = project output path.
      Returns:
        the report folder path.

    - #### isOverrideExisting

          boolean isOverrideExisting()

      Indicates whether the existing report files will be overridden. If false, each report filename gets an ordinal suffix.
      Returns:
        true if the existing report files will be overridden.

    - #### getReportLevel

          ReportLevel getReportLevel()

      Returns the level of events to be reported. Possible values: `ReportLevel`.
      Returns:
        the `ReportLevel` used for reporting events.

    - #### getSnapshotsLevel

          CaptureLevel getSnapshotsLevel()

      The snapshot capture level used to generate the UFT Developer report. Possible values: `CaptureLevel`
      Returns:
        the `CaptureLevel` used.

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: