Package com.hp.lft.report

Class ModifiableReportConfiguration

java.lang.Object
com.hp.lft.report.ModifiableReportConfiguration
All Implemented Interfaces:
ReportConfiguration
public class ModifiableReportConfiguration extends Object implements ReportConfiguration
The class used for configuring the run result report.

  • Field Details

    • reportEnabled

      protected boolean reportEnabled

    • reportGranularity

      protected ReportGranularity reportGranularity

    • reportFolder

      protected String reportFolder

    • title

      protected String title

    • description

      protected String description

    • targetDirectory

      protected String targetDirectory

    • isOverrideExisting

      protected boolean isOverrideExisting

    • reportLevel

      protected ReportLevel reportLevel

    • snapshotsLevel

      protected CaptureLevel snapshotsLevel

  • Constructor Details

    • ModifiableReportConfiguration

      public ModifiableReportConfiguration()
      Initializes a new instance of the ReportConfiguration class that is initialized with the report configuration values from the local leanft.properties file.

  • Method Details

    • isReportEnabled

      public boolean isReportEnabled()
      Description copied from interface: ReportConfiguration
      Indicates if the reporting is enabled. If false, the report won't be initialized and generated at all. Default = true
      Specified by:
      isReportEnabled in interface ReportConfiguration
      Returns:
      true if the reporting is enabled

    • setReportEnabled

      protected void setReportEnabled(boolean reportEnabled)

    • getReportGranularity

      public ReportGranularity getReportGranularity()
      Description copied from interface: ReportConfiguration
      Returns the granularity of report generation. Possible values: ReportGranularity.
      Specified by:
      getReportGranularity in interface ReportConfiguration

    • setReportGranularity

      protected void setReportGranularity(ReportGranularity granularity)

    • getReportFolder

      public String getReportFolder()
      Description copied from interface: ReportConfiguration
      Returns the name of the folder where the run results report is generated. Default = RunResults.
      Specified by:
      getReportFolder in interface ReportConfiguration
      Returns:
      name of the report folder.

    • setReportFolder

      public void setReportFolder(String folderName)

    • getTitle

      public String getTitle()
      Description copied from interface: ReportConfiguration
      Returns the run results report title. Default = Run Results.
      Specified by:
      getTitle in interface ReportConfiguration
      Returns:
      the title of the report.

    • setTitle

      public void setTitle(String title)

    • getDescription

      public String getDescription()
      Description copied from interface: ReportConfiguration
      Returns the description of the run results report. The description appears directly below the title in the report. By default, the description is empty.
      Specified by:
      getDescription in interface ReportConfiguration
      Returns:
      description of the Report.

    • setDescription

      public void setDescription(String description)

    • getTargetDirectory

      public String getTargetDirectory()
      Description copied from interface: ReportConfiguration
      Returns the root directory where report folders are generated. Default = project output path.
      Specified by:
      getTargetDirectory in interface ReportConfiguration
      Returns:
      the report folder path.

    • setTargetDirectory

      public void setTargetDirectory(String targetDirectory)

    • isOverrideExisting

      public boolean isOverrideExisting()
      Description copied from interface: ReportConfiguration
      Indicates whether the existing report files will be overridden. If false, each report filename gets an ordinal suffix.
      Specified by:
      isOverrideExisting in interface ReportConfiguration
      Returns:
      true if the existing report files will be overridden.

    • setOverrideExisting

      public void setOverrideExisting(boolean isOverrideExisting)

    • getReportLevel

      public ReportLevel getReportLevel()
      Description copied from interface: ReportConfiguration
      Returns the level of events to be reported. Possible values: ReportLevel.
      Specified by:
      getReportLevel in interface ReportConfiguration
      Returns:
      the ReportLevel used for reporting events.

    • setReportLevel

      public void setReportLevel(ReportLevel reportLevel)

    • getSnapshotsLevel

      public CaptureLevel getSnapshotsLevel()
      Description copied from interface: ReportConfiguration
      The snapshot capture level used to generate the report. Possible values: CaptureLevel
      Specified by:
      getSnapshotsLevel in interface ReportConfiguration
      Returns:
      the CaptureLevel used.

    • setSnapshotsLevel

      public void setSnapshotsLevel(CaptureLevel snapshotsLevel)