oracle.reports.plugin
Class PluginException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--oracle.reports.plugin.PluginException

All Implemented Interfaces:

java.io.Serializable

public class PluginException

extends java.lang.Exception

The exception class used in Plugin API to pass error information This class also defines the errors code which might be thrown by the API to Plugin upon errors.

See Also:

Serialized Form

Field Summary

static int	DIALOG_NOT_ALLOWED
static int	HELP_SYSTEM_FAIL
static int	INVALID_DIALOG_LOCATION
static int	INVALID_DIALOG_SIZE
static int	INVALID_HELP_TOPIC
static int	INVALID_HELPSET_ID
static int	INVALID_REPORT_OBJECT
static int	INVALID_REPORT_OBJECT_NAME
static int	REPORT_INTERNAL_ERROR The error codes of Plugin API (module name: "PluginAPI")
static int	SET_SIGNON_PARAMETRE_FAIL
static int	TRACE_WRITE_FAIL

Constructor Summary

PluginException(java.lang.String module, int errorCode, java.lang.String errorMsg)
Constructor

Method Summary

int	getErrorCode() Returns the error code of the exception.
java.lang.String	getModule() Returns the name of the module which raised the exception
java.lang.String	toString()

Methods inherited from class java.lang.Throwable

fillInStackTrace, getLocalizedMessage, getMessage, printStackTrace, printStackTrace, printStackTrace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

REPORT_INTERNAL_ERROR

public static final int REPORT_INTERNAL_ERROR

The error codes of Plugin API (module name: "PluginAPI")

INVALID_REPORT_OBJECT

public static final int INVALID_REPORT_OBJECT

INVALID_REPORT_OBJECT_NAME

public static final int INVALID_REPORT_OBJECT_NAME

DIALOG_NOT_ALLOWED

public static final int DIALOG_NOT_ALLOWED

INVALID_DIALOG_LOCATION

public static final int INVALID_DIALOG_LOCATION

INVALID_DIALOG_SIZE

public static final int INVALID_DIALOG_SIZE

HELP_SYSTEM_FAIL

public static final int HELP_SYSTEM_FAIL

INVALID_HELPSET_ID

public static final int INVALID_HELPSET_ID

INVALID_HELP_TOPIC

public static final int INVALID_HELP_TOPIC

TRACE_WRITE_FAIL

public static final int TRACE_WRITE_FAIL

SET_SIGNON_PARAMETRE_FAIL

public static final int SET_SIGNON_PARAMETRE_FAIL

Constructor Detail

PluginException

public PluginException(java.lang.String module,
                       int errorCode,
                       java.lang.String errorMsg)

Constructor

Parameters:

module - name of the module which raises the exception, such as "XMLPDS" for XML Plugin Data Source, "PLUGINAPI" for Plugin API itself, "REP" for Reports.

errorCode - code of the error, each module can define its own error codes.

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Throwable

getModule

public java.lang.String getModule()

Returns the name of the module which raised the exception

getErrorCode

public int getErrorCode()

Returns the error code of the exception. Each module should define its own error codes.