com.businessobjects.sdk.monitoring.probe
Class AbstractProbe

java.lang.Object
  com.businessobjects.sdk.monitoring.probe.AbstractProbe

All Implemented Interfaces:

IProbe

public abstract class AbstractProbe
extends java.lang.Object
implements IProbe

This abstract class provides the methods that are used to run the probes.

Constructor Summary

AbstractProbe(IProbeInfoObject probeInfoObject)
This constructor is used to get the property bag that contains the name and value of the virtual metric.

Method Summary

java.lang.String	getDescription() This method is used to retrieve the description of the probe.
java.util.Map	getInputParameters() This method is used to retrieve the map of the input parameters.
java.lang.String	getName() This method is used to retrieve the title of the probe InfoObject.
IProbeInfoObject	getProbeInfoObject() This method is used to retrieve the Probe InfoObject.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractProbe

public AbstractProbe(IProbeInfoObject probeInfoObject)

This constructor is used to get the property bag that contains the name and value of the virtual metric.

Parameters:

probeInfoObject - Info object that represents the probe

Method Detail

getDescription

public java.lang.String getDescription()

Description copied from interface: IProbe

This method is used to retrieve the description of the probe.

Specified by:

getDescription in interface IProbe

Returns:

Description of the probe InfoObject

getName

public java.lang.String getName()

Description copied from interface: IProbe

This method is used to retrieve the title of the probe InfoObject.

Specified by:

getName in interface IProbe

Returns:

Title of the probe InfoObject

getInputParameters

public java.util.Map getInputParameters()
                                 throws SDKException

Description copied from interface: IProbe

This method is used to retrieve the map of the input parameters.

Specified by:

getInputParameters in interface IProbe

Returns:

Map of the input parameters

Throws:

SDKException - An SDKException

getProbeInfoObject

public IProbeInfoObject getProbeInfoObject()

Description copied from interface: IProbe

This method is used to retrieve the Probe InfoObject.

Specified by:

getProbeInfoObject in interface IProbe

Returns:

IProbeInfoObject