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 the Plugin API to pass error information. This class also defines the error codes generated by the API to the plugin upon errors.
- See Also:
- Serialized Form
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 that 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 |
REPORT_INTERNAL_ERROR
public static final int REPORT_INTERNAL_ERROR
- The error codes of the 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
PluginException
public PluginException(java.lang.String module,
int errorCode,
java.lang.String errorMsg)
- Constructor
-
- Parameters:
module
- The name of the module that raises the exception, such as "XMLPDS" for the XML Plugin Data Source, "PLUGINAPI" for the Plugin API itself, "REP" for Reports.
errorCode
- The code of the error; each module can define its own error codes.
errorMsg
- The text description of the error.
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 that raised the exception.
getErrorCode
public int getErrorCode()
- Returns the error code of the exception. Each module should define its own error codes.
Copyright © 2003 Oracle Corporation. All Rights Reserved.