Package com.hp.lft.report

Class ReportAdditionalInfo

java.lang.Object

com.hp.lft.report.ReportAdditionalInfo

public class ReportAdditionalInfo
extends Object

Represents the information used to describe a custom step.

Constructor Summary

Constructors

Constructor	Description
ReportAdditionalInfo()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getData()	Returns the custom data that was set on the ReportAdditionalInfo object.
String	getDescription()	Returns the description that was set on the ReportAdditionalInfo object.
Throwable	getException()	Returns the throwable of the step on the ReportAdditionalInfo object.
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.
ReportAdditionalInfo	setData(Map<String,Object> additionalData)	Sets the custom additional data of the step on the ReportAdditionalInfo object.
ReportAdditionalInfo	setDescription(String description)	Sets the description of the step on the ReportAdditionalInfo object.
ReportAdditionalInfo	setException(Throwable throwable)	Sets the throwable of the step on the ReportAdditionalInfo object.
ReportAdditionalInfo	setImage(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.

Methods inherited from class java.lang.Object

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

Constructor Details

ReportAdditionalInfo

public ReportAdditionalInfo()

Method Details

setDescription

public ReportAdditionalInfo setDescription(String description)

Sets the description of the step on the ReportAdditionalInfo object.

Parameters:

description - - the description of the step.

Returns:

A ReportAdditionalInfo object.

setStatus

public ReportAdditionalInfo setStatus(Status status)

Sets the status of the step on the ReportAdditionalInfo object.

Parameters:

status - - the status of the step as Status.

Returns:

A ReportAdditionalInfo object.

setException

public ReportAdditionalInfo setException(Throwable throwable)

Sets the throwable of the step on the ReportAdditionalInfo object.

Parameters:

throwable - - the reason for the step failure, as a Throwable object.

Returns:

A ReportAdditionalInfo object.

setImage

public ReportAdditionalInfo setImage(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

setImagePath

public ReportAdditionalInfo setImagePath(String imagePath)
                                  throws ReportException

Sets the path of the image file of the step on the ReportAdditionalInfo object.

Parameters:

imagePath - - the absolute path to the custom image.

Returns:

A ReportAdditionalInfo object.

Throws:

ReportException

setData

public ReportAdditionalInfo setData(Map<String,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.

getDescription

public String getDescription()

Returns the description that was set on the ReportAdditionalInfo object.

Returns:

description.

getData

public Map<String,Object> getData()

Returns the custom data that was set on the ReportAdditionalInfo object.

Returns:

the map object containing custom data.

getStatus

public Status getStatus()

Returns the status that was set on the ReportAdditionalInfo object.

Returns:

the Status.

getException

public Throwable getException()

Returns the throwable of the step on the ReportAdditionalInfo object.

Returns:

throwable

getImage

public 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

getImagePath

public String getImagePath()
                    throws ReportException

Returns the path of the image file of the step that was set on the ReportAdditionalInfo object.

Returns:

The image as a RenderedImage object.

Throws:

ReportException