oracle.dacf.dataset
Class ExceptionProcessorEvent

java.lang.Object
  java.util.EventObject
      oracle.dacf.dataset.ExceptionProcessorEvent

All Implemented Interfaces:

java.io.Serializable

public class ExceptionProcessorEvent

extends java.util.EventObject

The ExceptionProcessorEvent is created when the ExceptionProcessor needs to call its listeners and communicate that a particular exception is going to be process for registration with the ErrorManager.

The Severity, Type and UserMessage event properties will be used to create the ErrorMessage that is stored with the ErrorManager.

It is expected that listeners will set the severity, type and UserMessage properties of the event to reflect the importance of the exception and how the exception needs to be displayed to the user.

Version:

SDK

See Also:

ErrorManager, ErrorMessage, ExceptionProcessor, ExceptionProcessorListener, Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

	ExceptionProcessorEvent(java.lang.Object source, int rowNum, java.lang.Exception except, ErrorType type, ErrorSeverity severity)
protected	ExceptionProcessorEvent(java.lang.Object source, int rowNum, java.lang.Exception except, ErrorType type, ErrorSeverity severity, java.lang.String msg)

Method Summary

java.lang.Exception	getException() Sets the Exception property of the ExceptionProcessorEvent.
int	getRownum() Sets the row number property of the ExceptionProcessorEvent.
ErrorSeverity	getSeverity() Returns the severity value for the exception.
ErrorType	getType() Returns the type value for the exception.
java.lang.String	getUserMessage() Returns the message that will be displayed to the user.

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

ExceptionProcessorEvent

public ExceptionProcessorEvent(java.lang.Object source,
                               int rowNum,
                               java.lang.Exception except,
                               ErrorType type,
                               ErrorSeverity severity)

Parameters:

source - The source object for the Exception to be processed.

rowNum - The current row, if applicable, when the Exception occured

except - The Excpetion object being processed

type - The ErrorMessage type

severity - The ErrorMessage severity

See Also:

ErrorMessage

ExceptionProcessorEvent

protected ExceptionProcessorEvent(java.lang.Object source,
                                  int rowNum,
                                  java.lang.Exception except,
                                  ErrorType type,
                                  ErrorSeverity severity,
                                  java.lang.String msg)

Method Detail

getException

public java.lang.Exception getException()

Sets the Exception property of the ExceptionProcessorEvent.

Returns:

The value of the Exception property for the ExceptionProcessorEvent.

getRownum

public int getRownum()

Sets the row number property of the ExceptionProcessorEvent.

Returns:

The value of the row number property for the ExceptionProcessorEvent.

getSeverity

public ErrorSeverity getSeverity()

Returns the severity value for the exception.

Returns:

Possible return values are the constants:

• UNDEFINED_SEVERITY
• WARNING
• ERROR
• FATAL_ERROR
• PANIC

See Also:

ErrorMessage, ErrorManager

getType

public ErrorType getType()

Returns the type value for the exception.

Returns:

The return values is one of the constants:

• UNDEFINED_TYPE
• USER
• APP_CLIENT
• APP_SERVER
• CLIENT_FRAMEWORK
• SERVER_FRAMEWORK

See Also:

ErrorMessage, ErrorManager

getUserMessage

public java.lang.String getUserMessage()

Returns the message that will be displayed to the user.

The user message is the short text message that will be displayed to the user when the ErrorInspector displayes the ErrorMessage that captures this exception.

Returns:

The message text to be displayed to the user.

See Also:

ErrorInspector, ErrorMessage