com.businessobjects.sdk.monitoring.probe
Interface IProbe

All Known Subinterfaces:
IDiagnosticProbe, IHealthProbe
All Known Implementing Classes:
AbstractProbe

public interface IProbe

This interface is the base interface for all the probes.


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.
 

Method Detail

getInputParameters

java.util.Map getInputParameters()
                                 throws SDKException

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

Returns:
Map of the input parameters
Throws:
SDKException - An SDKException

getName

java.lang.String getName()

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

Returns:
Title of the probe InfoObject

getDescription

java.lang.String getDescription()

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

Returns:
Description of the probe InfoObject

getProbeInfoObject

IProbeInfoObject getProbeInfoObject()

This method is used to retrieve the Probe InfoObject.

Returns:
IProbeInfoObject