Open topic with navigation

com.hp.lft.report

## Class ReportContextInfo

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

-     public class ReportContextInfo
      extends java.lang.Object

  Represents the information used to describe a reporting context.

- - ### 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
    --- | ---
    `ReportContextInfo` | `setDescription(String description)` Sets the description of the reporting context on the ReportContextInfo object.
    `ReportContextInfo` | `setData(Map<String, Object> additionalData)` Sets the custom additional data of the reporting context on the ReportContextInfo object.
    `ReportContextInfo` | `setMode(ReportContextMode contextMode)` Sets the mode of the reporting context on the ReportContextInfo object. Default value = Normal.
    `String` | `getDescription()` Returns the description that was set on the ReportContextInfo object.
    `Map<String, Object>` | `getData()` Returns the custom data that was set on the ReportContextInfo object.
    `ReportContextMode` | `getContextMode()` Returns the context mode that was set on the ReportContextInfo object.
    `ReportContextInfo` | `verificationMode()` Sets the mode of the reporting context to Verification.

- - ### Method Detail

    - #### setDescription

          public ReportContextInfo setDescription(java.lang.String description)

      Sets the description of the reporting context on the ReportContextInfo object.
      Parameters:
        `description` - the description of the reporting context.
      Returns:
        A ReportContextInfo object that can be used as a builder to set other fields.

    - #### setData

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

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

    - #### setMode

          public ReportContextInfo setMode(ReportContextMode contextMode)

      Sets the mode of the reporting context on the ReportContextInfo object. Default value = Normal.
      Parameters:
        `contextMode` - the context mode as ReportContextMode.
      Returns:
        A ReportContextInfo object that can be used as a builder to set other fields.

    - #### getDescription

          public java.lang.String getDescription()

      Returns the description that was set on the ReportContextInfo object.

      Returns:
        description

    - #### getData

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

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

    - #### getContextMode

          public ReportContextMode getContextMode()

      Returns the context mode that was set on the ReportContextInfo object.
      Returns:
        ReportContextMode

    - #### verificationMode

          public ReportContextInfo verificationMode()

      Sets the mode of the reporting context to Verification.
      Returns:
        A ReportContextInfo object that can be used as a builder to set other fields.