Package com.hp.lft.report

Interface ReportConfiguration

All Known Implementing Classes:
ModifiableReportConfiguration
public interface ReportConfiguration
Report configuration interface.

  • Method Details

    • 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

    • getReportGranularity

      ReportGranularity getReportGranularity()
      Returns the granularity of report generation. Possible values: ReportGranularity.

    • getReportFolder

      String getReportFolder()
      Returns the name of the folder where the run results report is generated. Default = RunResults.
      Returns:
      name of the report folder.

    • getTitle

      String getTitle()
      Returns the run results report title. Default = Run Results.
      Returns:
      the title of the report.

    • getDescription

      String getDescription()
      Returns the description of the run results report. The description appears directly below the title in the report. By default, the description is empty.
      Returns:
      description of the Report.

    • getTargetDirectory

      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 report. Possible values: CaptureLevel
      Returns:
      the CaptureLevel used.