ilog.views.appframe.plugin
Class IlvPluginException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          ilog.views.appframe.plugin.IlvPluginException

All Implemented Interfaces:

Serializable

public class IlvPluginException
extends Exception

This exception is thrown by the plugin manager to indicate that an error occurred when installing or uninstalling a plug-in.

See Also:

Serialized Form

Field Summary

static String	BAD_VERSION_ID_ERROR This error ID indicates that a bad version identifier has been set to a plug-in.
static String	DEPENDENCY_ERROR This error ID indicates that the plugin manager could not resolve dependencies between plugins.
static String	MANIFEST_ERROR This error ID indicates that an error occurred while parsing a plug-in manifest file.
static String	PLUGIN_INSTALLER_ERROR This error ID indicates that an error occurred while invoking the IlvPluginInstaller of a plug-in.
static String	RESOURCE_FILE_ERROR This error ID indicates that it was not possible to locate a resource file specified in the manifest file of a plug-in.
static String	SETTINGS_OBJECTS_ERROR This error ID indicates that an error occurred while installing or uninstalling objects that were declared in the settings of a plug-in, as extensions of a docking area or document templates.
static String	UNKNOWN_ERROR This error ID indicates that an unknown error occurred while installing or uninstalling a plug-in.

Method Summary

String	getErrorID() Returns the ID of the error.
Exception	getException() Returns the exception that occurred while installing or uninstalling the plugin.
IlvPlugin	getPlugin() Returns the plugin which installation or uninstallation has generated an exception.
boolean	isFatal() Determines whether this exception is fatal for the installation of the plug-in that generated this exception.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Detail

MANIFEST_ERROR

public static final String MANIFEST_ERROR

This error ID indicates that an error occurred while parsing a plug-in manifest file.

See Also:

Constant Field Values

BAD_VERSION_ID_ERROR

public static final String BAD_VERSION_ID_ERROR

This error ID indicates that a bad version identifier has been set to a plug-in.

See Also:

Constant Field Values

DEPENDENCY_ERROR

public static final String DEPENDENCY_ERROR

This error ID indicates that the plugin manager could not resolve dependencies between plugins.

See Also:

Constant Field Values

RESOURCE_FILE_ERROR

public static final String RESOURCE_FILE_ERROR

This error ID indicates that it was not possible to locate a resource file specified in the manifest file of a plug-in.

See Also:

Constant Field Values

SETTINGS_OBJECTS_ERROR

public static final String SETTINGS_OBJECTS_ERROR

This error ID indicates that an error occurred while installing or uninstalling objects that were declared in the settings of a plug-in, as extensions of a docking area or document templates.

See Also:

Constant Field Values

PLUGIN_INSTALLER_ERROR

public static final String PLUGIN_INSTALLER_ERROR

This error ID indicates that an error occurred while invoking the IlvPluginInstaller of a plug-in.

See Also:

Constant Field Values

UNKNOWN_ERROR

public static final String UNKNOWN_ERROR

This error ID indicates that an unknown error occurred while installing or uninstalling a plug-in.

See Also:

Constant Field Values

Method Detail

getPlugin

public IlvPlugin getPlugin()

Returns the plugin which installation or uninstallation has generated an exception.

getException

public Exception getException()

Returns the exception that occurred while installing or uninstalling the plugin.

The returned exception can be null if the problem was not due to an exception that has been internally caught.

In any case, the message of this plugin exception provides a description of the problem that occurred.

See Also:

Throwable.getMessage()

isFatal

public boolean isFatal()

Determines whether this exception is fatal for the installation of the plug-in that generated this exception.

Returns:

true if this exception causes the plug-in to stop its installation process. This method returns false is the installation of the plug-in can continue.

getErrorID

public String getErrorID()

Returns the ID of the error. The returned value can be one of the following:

• MANIFEST_ERROR
• BAD_VERSION_ID_ERROR
• DEPENDENCY_ERROR
• RESOURCE_FILE_ERROR
• SETTINGS_OBJECTS_ERROR
• PLUGIN_INSTALLER_ERROR
• UNKNOWN_ERROR

The Throwable.getMessage() method provides a description on the error that occurred.