com.businessobjects.sdk.monitoring.probe
Interface IProbeResult

All Known Subinterfaces:

IDiagnosticProbeResult, IHealthProbeResult

All Known Implementing Classes:

DiagnosticProbeResult, HealthProbeResult

public interface IProbeResult

This is the base interface for all the probe results.

Method Summary

long	getDuration() This method is used to retrieve the probe execution time in seconds.
boolean	getResult() This method is used to retrieve the probe result.
boolean	isTimedOut() This method is used to know if the probe is timed out.
void	probeFailed() This method is used to indicate the status - probe execution failed.
void	probeSucceeded() This method is used to indicate the status - probe execution succeeded.
void	probeTimedout() This method is used when the probe is timed out.
void	setDescription(java.lang.String desc) This method is used to set the description of the probe.
void	setDuration(long duration) This method is used to set the execution time of the probe.
void	setErrorMessage(java.lang.String errorMessage) This method is used to set the error messages when the probe is executed.
void	setException(java.lang.Exception ex) This method is used to set the exception for the probe.
void	setName(java.lang.String name) This method is used to set the name of the probe.

Method Detail

probeSucceeded

void probeSucceeded()

This method is used to indicate the status - probe execution succeeded.

probeFailed

void probeFailed()

This method is used to indicate the status - probe execution failed.

setDuration

void setDuration(long duration)

This method is used to set the execution time of the probe.

Parameters:

duration - Time in seconds for the execution of probe

setErrorMessage

void setErrorMessage(java.lang.String errorMessage)

This method is used to set the error messages when the probe is executed.

Parameters:

errorMessage - Error message returned when the probe is executed.

setName

void setName(java.lang.String name)

This method is used to set the name of the probe.

Parameters:

name - Name of the probe

setDescription

void setDescription(java.lang.String desc)

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

Parameters:

desc - Description of the probe

setException

void setException(java.lang.Exception ex)

This method is used to set the exception for the probe.

Parameters:

ex - Exception thrown when the probe is made to run

getDuration

long getDuration()

This method is used to retrieve the probe execution time in seconds.

Returns:

Probe execution time in seconds

getResult

boolean getResult()

This method is used to retrieve the probe result.

Returns:

Probe Result

probeTimedout

void probeTimedout()

This method is used when the probe is timed out.

isTimedOut

boolean isTimedOut()

This method is used to know if the probe is timed out.

Returns:

True, if the probe is timed out, false otherwise.