Package com.hp.lft.report

Class ReportContextInfo

java.lang.Object

com.hp.lft.report.ReportContextInfo

public class ReportContextInfo
extends Object

Represents the information used to describe a reporting context.

Constructor Summary

Constructors

Constructor	Description
ReportContextInfo()

Method Summary

Modifier and Type	Method	Description
ReportContextMode	getContextMode()	Returns the context mode which was set on the ReportContextInfo object.
Map<String,Object>	getData()	Returns the custom data which was set on the ReportContextInfo object.
String	getDescription()	Returns the description which was set on the ReportContextInfo object.
ReportContextInfo	setData(Map<String,Object> additionalData)	Sets the custom additional data of the reporting context on the ReportContextInfo object.
ReportContextInfo	setDescription(String description)	Sets the description of the reporting context on the ReportContextInfo object.
ReportContextInfo	setMode(ReportContextMode contextMode)	Sets the mode of the reporting context.
static ReportContextInfo	verificationMode()	Sets the mode of the reporting context to Verification.

Methods inherited from class java.lang.Object

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

Constructor Details

ReportContextInfo

public ReportContextInfo()

Method Details

setDescription

public ReportContextInfo setDescription(String description)

Sets the description of the reporting context on the ReportContextInfo object.

Parameters:

description - - the description of the reporting context.

Returns:

ReportContextInfo object that can be used as a builder to set other fields.

setData

public ReportContextInfo setData(Map<String,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:

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. Default value = Normal.

Parameters:

contextMode - - the context mode as ReportContextMode.

Returns:

ReportContextInfo object that can be used as a builder to set other fields.

getDescription

public String getDescription()

Returns the description which was set on the ReportContextInfo object.

Returns:

description

getData

public Map<String,Object> getData()

Returns the custom data which was set on the ReportContextInfo object.

Returns:

the map object containing custom data.

getContextMode

public ReportContextMode getContextMode()

Returns the context mode which was set on the ReportContextInfo object.

Returns:

ReportContextMode

verificationMode

public static ReportContextInfo verificationMode()

Sets the mode of the reporting context to Verification.

Returns:

ReportContextInfo object that can be used as a builder to set other fields.