Open topic with navigation

com.hp.lft.report

## Class ModifiableReportConfiguration

- java.lang.Object
- - com.hp.lft.report.ModifiableReportConfiguration

- All Implemented Interfaces:
    ReportConfiguration

      public class ModifiableReportConfiguration
      extends java.lang.Object
      implements ReportConfiguration

  The class used for configuring the LeanFT report.

- - ### Field Summary

    Modifier and Type | Field and Description
    --- | ---
    `protected java.lang.String` | `description`
    `protected boolean` | `isOverrideExisting`
    `protected boolean` | `reportEnabled`
    `protected java.lang.String` | `reportFolder`
    `protected ReportLevel` | `reportLevel`
    `protected CaptureLevel` | `snapshotsLevel`
    `protected java.lang.String` | `targetDirectory`
    `protected java.lang.String` | `title`

  - ### Constructor Summary

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

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `java.lang.String` | `getDescription()` Returns the LeanFT report description.
    `java.lang.String` | `getReportFolder()` Returns the name of the folder where the LeanFT report is generated.
    `ReportLevel` | `getReportLevel()` Returns the level of events to be reported.
    `CaptureLevel` | `getSnapshotsLevel()` The snapshot capture level used to generate the LeanFT report.
    `java.lang.String` | `getTargetDirectory()` Returns the root directory where report folders are generated.
    `java.lang.String` | `getTitle()` Returns the LeanFT report title.
    `boolean` | `isOverrideExisting()` Indicates whether the existing report files will be overridden.
    `boolean` | `isReportEnabled()` Indicates if the reporting is enabled.
    `void` | `setDescription(java.lang.String description)`
    `void` | `setOverrideExisting(boolean isOverrideExisting)`
    `protected void` | `setReportEnabled(boolean reportEnabled)`
    `void` | `setReportFolder(java.lang.String folderName)`
    `void` | `setReportLevel(ReportLevel reportLevel)`
    `void` | `setSnapshotsLevel(CaptureLevel snapshotsLevel)`
    `void` | `setTargetDirectory(java.lang.String targetDirectory)`
    `void` | `setTitle(java.lang.String title)`

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

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

- - ### Field Detail

    - #### reportEnabled

          protected boolean reportEnabled

    - #### reportFolder

          protected java.lang.String reportFolder

    - #### title

          protected java.lang.String title

    - #### description

          protected java.lang.String description

    - #### targetDirectory

          protected java.lang.String targetDirectory

    - #### isOverrideExisting

          protected boolean isOverrideExisting

    - #### reportLevel

          protected ReportLevel reportLevel

    - #### snapshotsLevel

          protected CaptureLevel snapshotsLevel

  - ### Constructor Detail

    - #### 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 Detail

    - #### 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)

    - #### getReportFolder

          public java.lang.String getReportFolder()

      Description copied from interface: `ReportConfiguration`
      Returns the name of the folder where the LeanFT report is generated. Default = RunResults.
      Specified by:
        `getReportFolder` in interface `ReportConfiguration`
      Returns:
        name of the report folder.

    - #### setReportFolder

          public void setReportFolder(java.lang.String folderName)

    - #### getTitle

          public java.lang.String getTitle()

      Description copied from interface: `ReportConfiguration`
      Returns the LeanFT report title. Default = Run Results.
      Specified by:
        `getTitle` in interface `ReportConfiguration`
      Returns:
        the title of the report.

    - #### setTitle

          public void setTitle(java.lang.String title)

    - #### getDescription

          public java.lang.String getDescription()

      Description copied from interface: `ReportConfiguration`
      Returns the LeanFT report description. The description appears directly below the title in the LeanFT report. By default, the description is empty.
      Specified by:
        `getDescription` in interface `ReportConfiguration`
      Returns:
        description of the Report.

    - #### setDescription

          public void setDescription(java.lang.String description)

    - #### getTargetDirectory

          public java.lang.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(java.lang.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 LeanFT report. Possible values: `CaptureLevel`
      Specified by:
        `getSnapshotsLevel` in interface `ReportConfiguration`
      Returns:
        the `CaptureLevel` used.

    - #### setSnapshotsLevel

          public void setSnapshotsLevel(CaptureLevel snapshotsLevel)