com.businessobjects.sdk.monitoring.probe
Class DiagnosticProbeResult

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

All Implemented Interfaces:

IDiagnosticProbeResult, IProbeResult

public class DiagnosticProbeResult
extends java.lang.Object
implements IDiagnosticProbeResult

This class is used to represent the result of a Diagnostic Probe.

Constructor Summary

DiagnosticProbeResult()
Constructor

Method Summary

void	addDiagnosticMessage(java.lang.String message) This method is used to add the diagnostic messages to the diagnostic result.
java.lang.String	getDescription() This method is used to retrieve the description of the probe.
java.lang.StringBuffer	getDiagnosticMessages() This method is used to get the diagnostic messages of the probe.
long	getDuration() This method is used to retrieve the probe execution time in seconds.
java.lang.String	getName() This method is used to retrieve the name of the probe.
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 description) 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	setLocale(java.util.Locale l) This method is used to set the locale.
void	setName(java.lang.String name) This method is used to set the name of the probe.

Methods inherited from class java.lang.Object

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

Constructor Detail

DiagnosticProbeResult

public DiagnosticProbeResult()

Constructor

Method Detail

getDiagnosticMessages

public java.lang.StringBuffer getDiagnosticMessages()

Description copied from interface: IDiagnosticProbeResult

This method is used to get the diagnostic messages of the probe.

Specified by:

getDiagnosticMessages in interface IDiagnosticProbeResult

Returns:

Diagnostic messages

probeFailed

public void probeFailed()

Description copied from interface: IProbeResult

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

Specified by:

probeFailed in interface IProbeResult

probeSucceeded

public void probeSucceeded()

Description copied from interface: IProbeResult

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

Specified by:

probeSucceeded in interface IProbeResult

getName

public java.lang.String getName()

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

Returns:

Name of the probe

setName

public void setName(java.lang.String name)

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

Specified by:

setName in interface IProbeResult

Parameters:

name - Name of the probe

getDescription

public java.lang.String getDescription()

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

Returns:

Description of the probe

setDescription

public void setDescription(java.lang.String description)

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

Specified by:

setDescription in interface IProbeResult

Parameters:

description - description of the probe

setDuration

public void setDuration(long duration)

Description copied from interface: IProbeResult

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

Specified by:

setDuration in interface IProbeResult

Parameters:

duration - Time in seconds for the execution of probe

addDiagnosticMessage

public void addDiagnosticMessage(java.lang.String message)

Description copied from interface: IDiagnosticProbeResult

This method is used to add the diagnostic messages to the diagnostic result.

Specified by:

addDiagnosticMessage in interface IDiagnosticProbeResult

Parameters:

message - Individual Diagnostic Message

setErrorMessage

public void setErrorMessage(java.lang.String errorMessage)

Description copied from interface: IProbeResult

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

Specified by:

setErrorMessage in interface IProbeResult

Parameters:

errorMessage - Error message returned when the probe is executed.

setException

public void setException(java.lang.Exception ex)

Description copied from interface: IProbeResult

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

Specified by:

setException in interface IProbeResult

Parameters:

ex - Exception thrown when the probe is made to run

getDuration

public long getDuration()

Description copied from interface: IProbeResult

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

Specified by:

getDuration in interface IProbeResult

Returns:

Probe execution time in seconds

getResult

public boolean getResult()

Description copied from interface: IProbeResult

This method is used to retrieve the probe result.

Specified by:

getResult in interface IProbeResult

Returns:

Probe Result

probeTimedout

public void probeTimedout()

Description copied from interface: IProbeResult

This method is used when the probe is timed out.

Specified by:

probeTimedout in interface IProbeResult

isTimedOut

public boolean isTimedOut()

Description copied from interface: IProbeResult

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

Specified by:

isTimedOut in interface IProbeResult

Returns:

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

setLocale

public void setLocale(java.util.Locale l)

Description copied from interface: IDiagnosticProbeResult

This method is used to set the locale.

Specified by:

setLocale in interface IDiagnosticProbeResult

Parameters:

l - Locale