ilog.views.appframe.plugin

Interface IlvPluginInstaller

public interface IlvPluginInstaller

Plug-in installers are associated with plug-ins for performing additional initialization work that cannot be done when parameterizing "plugin.xml" files.

For example, it is possible for a plug-in installer to add new global action handlers to the application.

Method Summary

Modifier and Type	Method and Description
boolean	canInstall(IlvApplication application, IlvPlugin plugin) Determines whether the specified plugin can be installed in the host application.
boolean	canUninstall(IlvApplication application, IlvPlugin plugin) Determines whether the plug-in can be uninstalled from the host application.
void	install(IlvApplication application, IlvPlugin plugin) Invoked to install the plug-in in the host application.
void	uninstall(IlvApplication application, IlvPlugin plugin) Invoked to uninstall the plug-in from the host application.

Method Detail

install

void install(IlvApplication application,
             IlvPlugin plugin)

Invoked to install the plug-in in the host application. At this stage, all the data specified in the plugin.xml file associated with the plug-in has been installed in the application. It is possible to access the settings and the resources specified for the plug-in through the application.

Parameters:

application - The application to install the plug-in in.

plugin - The plug-in that this installer is associated with.

See Also:

canInstall(ilog.views.appframe.IlvApplication, ilog.views.appframe.plugin.IlvPlugin), uninstall(ilog.views.appframe.IlvApplication, ilog.views.appframe.plugin.IlvPlugin)

canInstall

boolean canInstall(IlvApplication application,
                   IlvPlugin plugin)

Determines whether the specified plugin can be installed in the host application.

If this method returns false, the plug-in will not be installed.
Otherwise, the installation process of the plug-in will continue without guarantees that the plug-in will eventually be installed. The installation of the plug-in also depends on the installation mode specified in its settings.

This method is invoked before any settings files referenced in the plugin.xml file of the plug-in are installed in the application. Thus, plug-in data cannot be used through the application methods to determine whether the plug-in should be installed or not.

Parameters:

application - The application to install the plug-in in.

plugin - The plug-in associated with this installer.

Returns:

true if the plug-in can be installed; false otherwise.

See Also:

install(ilog.views.appframe.IlvApplication, ilog.views.appframe.plugin.IlvPlugin), canInstall(ilog.views.appframe.IlvApplication, ilog.views.appframe.plugin.IlvPlugin), IlvPluginManager.isInitiallyInstalled(ilog.views.appframe.plugin.IlvPlugin)

uninstall

void uninstall(IlvApplication application,
               IlvPlugin plugin)

Invoked to uninstall the plug-in from the host application. The implementation of this method must not attempt to remove the data installed for this plug-in in the application that was specified in the plugin.xml file of the plug-in. It is done automatically after this method has been called.

Parameters:

application - The application to uninstall the plug-in from.

plugin - The plug-in this installer must perform some initializations for.

See Also:

install(ilog.views.appframe.IlvApplication, ilog.views.appframe.plugin.IlvPlugin), canUninstall(ilog.views.appframe.IlvApplication, ilog.views.appframe.plugin.IlvPlugin)

canUninstall

boolean canUninstall(IlvApplication application,
                     IlvPlugin plugin)

Determines whether the plug-in can be uninstalled from the host application.

This method must return true if the plug-in can be uninstalled.
If this method returns false, the uninstallation of the plug-in is stopped and data that was specified in the plugin.xml file associated with the plug-in remains installed in the application.

Parameters:

application - The application to uninstall the plug-in from.

plugin - The plug-in associated with this installer.

Returns:

true if the plug-in can be uninstalled; false otherwise.