com.businessobjects.sdk.monitoring.probe
Interface IHealthProbeResult

All Superinterfaces:

IProbeResult

All Known Implementing Classes:

HealthProbeResult

public interface IHealthProbeResult
extends IProbeResult

This interface is used to access the HealthProbeResult.

Method Summary

IProbeInfoObject	getProbeInfoObject() This method is used to get the Probe InfoObject.
java.util.Map	getProbeMetrics() This method is used to get the map of the Virtual Metrics.
void	setProbeInfoObject(IProbeInfoObject probeInfoObject) This method is used to set the Probe InfoObject.
void	setProbeMetrics(java.lang.String name, java.lang.Object value) This method is used to set the value for a Virtual Metric.
void	setProbeMetricsMap(java.util.Map map) This method is used to set the probe metrics map.

Methods inherited from interface com.businessobjects.sdk.monitoring.probe.IProbeResult

getDuration, getResult, isTimedOut, probeFailed, probeSucceeded, probeTimedout, setDescription, setDuration, setErrorMessage, setException, setName

Method Detail

getProbeMetrics

java.util.Map getProbeMetrics()

This method is used to get the map of the Virtual Metrics.

Returns:

Map of the Virtual Metrics

setProbeMetrics

void setProbeMetrics(java.lang.String name,
                     java.lang.Object value)
                     throws MonitoringException,
                            SDKException

This method is used to set the value for a Virtual Metric.

Parameters:

name - name of the metric

value - value of the metric

Throws:

MonitoringException - MetricsNotFound.

SDKException - An SDKException

setProbeMetricsMap

void setProbeMetricsMap(java.util.Map map)
                        throws SDKException

This method is used to set the probe metrics map.

Parameters:

map - virtual metrics map

Throws:

SDKException - SDKException

setProbeInfoObject

void setProbeInfoObject(IProbeInfoObject probeInfoObject)

This method is used to set the Probe InfoObject.

Parameters:

probeInfoObject - Info Object of the health probe

getProbeInfoObject

IProbeInfoObject getProbeInfoObject()

This method is used to get the Probe InfoObject.

Returns:

ProbeInfoObject