com.biocomfort.SDK.event
Class ErrorEvent

java.lang.Object
  extended by java.util.EventObject
      extended by com.biocomfort.SDK.event.ErrorEvent
All Implemented Interfaces:
java.io.Serializable

public class ErrorEvent
extends java.util.EventObject

A error event which indicates that a runtime error occured in the SDK. The event is passed to every SDKErrorListener object that registered to receive such events using the SDK's addSDKErrorListener method.

See Also:
SDKErrorListener, Serialized Form

Field Summary
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
ErrorEvent()
          Constructs an ErrorEvent object.
ErrorEvent(java.lang.Object source)
          Constructs an ErrorEvent object with specifying the source.
ErrorEvent(java.lang.Object source, ErrorType errorType)
          Constructs an ErrorEvent object with specifying the source and the error type.
ErrorEvent(java.lang.Object source, ErrorType errorType, java.lang.String additionalErrorDescription)
          Constructs an ErrorEvent object with specifying the source, the error type and the error description.
ErrorEvent(java.lang.Object source, ErrorType errorType, java.lang.String additionalErrorDescription, java.lang.Throwable causingThrowable)
          Constructs an ErrorEvent object with specifying the source, the error type, the error description and the causing Throwable.
ErrorEvent(java.lang.Object source, MedicalDeviceTO medicalDevice, ErrorType errorType, java.lang.String additionalErrorDescription, java.lang.Throwable causingThrowable)
          Constructs an ErrorEvent object with specifying the source, the medical device, the error type, the error description and the causing Throwable.
ErrorEvent(java.lang.Object source, MedicalDeviceTO medicalDevice, ErrorType errorType, java.lang.String additionalErrorDescription, java.lang.Throwable causingThrowable, java.util.Date when)
          Constructs an ErrorEvent object with specifying the source, the medical device, the error type, the error description and the causing Throwable.
 
Method Summary
 java.lang.String getAdditionalErrorDescription()
          Returns a description string associated with this error event.
 java.lang.Throwable getCausingThrowable()
          Returns a Throwable object that causes this error event.
 ErrorType getErrorType()
          Returns the error type associated with this error event.
 MedicalDeviceTO getMedicalDevice()
          Returns a description of a medical device associated with this action.
 java.util.Date getWhen()
          Returns the date time of when this error event occurred.
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ErrorEvent

public ErrorEvent(java.lang.Object source,
                  MedicalDeviceTO medicalDevice,
                  ErrorType errorType,
                  java.lang.String additionalErrorDescription,
                  java.lang.Throwable causingThrowable,
                  java.util.Date when)
Constructs an ErrorEvent object with specifying the source, the medical device, the error type, the error description and the causing Throwable.

Parameters:
source - the object that originated the event
medicalDevice - the description of the medical device with which the error occured
errorType - the type of error that occured
additionalErrorDescription - a string that may specify or describe the error
causingThrowable - a Throwable object that causes the error
when - the date time the event occurred
See Also:
ErrorType

ErrorEvent

public ErrorEvent(java.lang.Object source,
                  MedicalDeviceTO medicalDevice,
                  ErrorType errorType,
                  java.lang.String additionalErrorDescription,
                  java.lang.Throwable causingThrowable)
Constructs an ErrorEvent object with specifying the source, the medical device, the error type, the error description and the causing Throwable.

Parameters:
source - the object that originated the event
medicalDevice - the description of the medical device with which the error occured
errorType - the type of error that occured
additionalErrorDescription - a string that may specify or describe the error
causingThrowable - a Throwable object that causes the error
See Also:
ErrorType

ErrorEvent

public ErrorEvent(java.lang.Object source,
                  ErrorType errorType,
                  java.lang.String additionalErrorDescription,
                  java.lang.Throwable causingThrowable)
Constructs an ErrorEvent object with specifying the source, the error type, the error description and the causing Throwable.

Parameters:
source - the object that originated the event
errorType - the type of error that occured
additionalErrorDescription - a string that may specify or describe the error
causingThrowable - a Throwable object that causes the error
See Also:
ErrorType

ErrorEvent

public ErrorEvent(java.lang.Object source,
                  ErrorType errorType,
                  java.lang.String additionalErrorDescription)
Constructs an ErrorEvent object with specifying the source, the error type and the error description.

Parameters:
source - the object that originated the event
errorType - the type of error that occured
additionalErrorDescription - a string that may specify or describe the error
See Also:
ErrorType

ErrorEvent

public ErrorEvent(java.lang.Object source,
                  ErrorType errorType)
Constructs an ErrorEvent object with specifying the source and the error type.

Parameters:
source - the object that originated the event
errorType - the type of error that occured

ErrorEvent

public ErrorEvent(java.lang.Object source)
Constructs an ErrorEvent object with specifying the source.

Parameters:
source - the object that originated the event

ErrorEvent

public ErrorEvent()
Constructs an ErrorEvent object.

Method Detail

getErrorType

public ErrorType getErrorType()
Returns the error type associated with this error event.

Returns:
this error event's type
See Also:
ErrorType

getAdditionalErrorDescription

public java.lang.String getAdditionalErrorDescription()
Returns a description string associated with this error event. This string may specify or describe the error event more exactly.

Returns:
a string that specifies or describes the error event

getMedicalDevice

public MedicalDeviceTO getMedicalDevice()
Returns a description of a medical device associated with this action.

Returns:
a medical device's description with which the error occured

getCausingThrowable

public java.lang.Throwable getCausingThrowable()
Returns a Throwable object that causes this error event.

Returns:
the error event's causing Throwable object

getWhen

public java.util.Date getWhen()
Returns the date time of when this error event occurred.

Returns:
this error event's date time