Open topic with navigation

com.hp.lft.report

## Class ReportAdditionalInfo

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

-     public class ReportAdditionalInfo
      extends java.lang.Object

  Represents the information used to describe a custom step.

- - ### Method Summary

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

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

    Modifier and Type | Method and Description
    --- | ---
    `ReportAdditionalInfo` | `setDescription(String description)` Sets the description of the step on the ReportAdditionalInfo object.
    `ReportAdditionalInfo` | `setData(Map<String, Object> additionalData)` Sets the custom additional data of the step on the ReportAdditionalInfo object.
    `ReportAdditionalInfo` | `setException(java.lang.Throwable throwable)` Sets the throwable of the step on the ReportAdditionalInfo object.
    `ReportAdditionalInfo` | `setImage(java.awt.image.RenderedImage image)` Sets the image of the step on the ReportAdditionalInfo object.
    `ReportAdditionalInfo` | `setImagePath(String imagePath)` Sets the path of the image file of the step on the ReportAdditionalInfo object.
    `ReportAdditionalInfo` | `setStatus(Status status)` Sets the status of the step on the ReportAdditionalInfo object.
    `String` | `getDescription()` Returns the description that was set on the ReportAdditionalInfo object.
    `Map<String, Object>` | `getData()` Returns the custom data that was set on the ReportAdditionalInfo object.
    `java.lang.Throwable` | `getException()` Returns the throwable of the step on the ReportAdditionalInfo object.
    `java.awt.image.RenderedImage` | `getImage()` Returns the image of the step that was set on the ReportAdditionalInfo object.
    `String` | `getImagePath()` Returns the path of the image file of the step that was set on the ReportAdditionalInfo object.
    `Status` | `getStatus()` Returns the status that was set on the ReportAdditionalInfo object.

- - ### Method Detail

    - #### setDescription

          public ReportAdditionalInfo setDescription(java.lang.String description)

      Sets the description of the step on the ReportAdditionalInfo object.
      Parameters:
        `description` - the description of the step.
      Returns:
        A ReportAdditionalInfo object.

    - #### setData

          public ReportAdditionalInfo setData(Map<java.lang.String, java.lang.Object> additionalData)

      Sets the custom additional data of the step on the ReportAdditionalInfo object.
      Parameters:
        `additionalData` - the custom additional data as a Map object.
      Returns:
        A ReportAdditionalInfo object that can be used as a builder to set other fields.

    - #### setException

          public ReportAdditionalInfo setException(java.lang.Throwable throwable)

      Sets the throwable of the step on the ReportAdditionalInfo object.
      Parameters:
        `status` - the reason for the report failure, as a Throwable object.
      Returns:
        A ReportAdditionalInfo object.

    - #### setImage

          public ReportAdditionalInfo setImage(java.awt.image.RenderedImage image)
                                  throws ReportException

      Sets the image of the step on the ReportAdditionalInfo object.
      Parameters:
        `image` - the image of the step as a RenderedImage object.
      Returns:
        A ReportAdditionalInfo object.
      Throws:
        `ReportException` - if error occurs in the report

    - #### setImagePath

          public ReportAdditionalInfo setImage(java.lang.String imagePath)
          										throws ReportException

      Sets the path of the image of the step on the ReportAdditionalInfo object.
      Parameters:
        `imagePath` - the absolute path to the custom image.
      Returns:
        A ReportAdditionalInfo object.
      Throws:
        `ReportException` - if error occurs in the report

    - #### setStatus

          public ReportAdditionalInfo setStatus(Status status)

      Sets the status of the step on the ReportAdditionalInfo object.
      Parameters:
        `status` - the status of the step as LFT.Report.Status.
      Returns:
        A ReportAdditionalInfo object

    - #### getDescription

          public java.lang.String getDescription()

      Returns the description that was set on the ReportAdditionalInfo object.

      Returns:
        description

    - #### getData

          public Map<java.lang.String, java.lang.Object> getData()

      Returns the custom data that was set on the ReportAdditionalInfo object.
      Returns:
        the map object containing custom data

    - #### getException

          public java.lang.Throwable getException()

      Returns throwable of the step on the ReportAdditionalInfo object.
      Returns:
        throwable

    - #### getImage

          public java.awt.image.RenderedImage getImage()
                                  throws ReportException

      Returns the image of the step that was set on the ReportAdditionalInfo object.
      Returns:
        The image as a RenderedImage object.
      Throws:
        `ReportException` - if error occurs in the report

    - #### getImagePath

          public java.lang.String getImagePath()
                                  throws ReportException

      Returns the path of the image file of the step that was set on the ReportAdditionalInfo object.
      Returns:
        The absolute path to the custom image.
      Throws:
        `ReportException` - if error occurs in the report

    - #### getStatus

          public Status getStatus()

      Returns the status that was set on the ReportAdditionalInfo object.

      Returns:
        The Status