com.unitesk.atp.tool
Interface PluginManager

All Known Subinterfaces:

PluginManager

All Known Implementing Classes:

PluginManagerClass, PluginManagerClass, Tool, Tool

public interface PluginManager

Plugin manager interface.

Version:

$Id: PluginManager.java,v 1.1 2004/10/09 06:43:21 all-x Exp $

Author:

Alexey Demakov

Method Summary

MessageBox	getMessageBox() Returns message box.
String	getName() Get plugin manager name.
Object	getPlugin(String name) Returns the plugin with the specified name.
String	getPluginProperty(Object plugin, String name) Gets the value of a plugin property with the specified name for the specified plugin.
String	getPluginProperty(Object plugin, String name, String value) Gets the value of a plugin property with the specified name for the specified plugin or default value if this property is not defined.
String	getPluginPropertyName(Object plugin, String name) Gets the qualified property name for plugin property name of the specified plugin.

Method Detail

getName

String getName()

Get plugin manager name.

getMessageBox

MessageBox getMessageBox()

Returns message box.

getPlugin

Object getPlugin(String name)

Returns the plugin with the specified name.

Parameters:

name - The plugin name.

Returns:

The plugin with the specified name or null.

getPluginPropertyName

String getPluginPropertyName(Object plugin,
                             String name)

Gets the qualified property name for plugin property name of the specified plugin.

Parameters:

plugin - The specified plugin.

name - The name of plugin property.

Returns:

The corresponding qualified property name. For plugin property property.name of plugin with name plugin of manager manager qualified property name is manager.plugin.property.name.

Throws:

IllegalArgumentException - If plugin is not a plugin of this manager.

See Also:

DynamicVariablesTable.getPropertyName(Object,String)

getPluginProperty

String getPluginProperty(Object plugin,
                         String name)

Gets the value of a plugin property with the specified name for the specified plugin.

Parameters:

plugin - The specified plugin.

name - The name of plugin property.

Returns:

The value of the plugin property for the specified plugin.

Throws:

IllegalArgumentException - If plugin is not a plugin of this manager.

See Also:

DynamicVariablesTable.getProperty(Object,String)

getPluginProperty

String getPluginProperty(Object plugin,
                         String name,
                         String value)

Gets the value of a plugin property with the specified name for the specified plugin or default value if this property is not defined.

Parameters:

plugin - The specified plugin.

name - The name of plugin property.

value - The default value is used if for the specified plugin there is no property with the specified name.

Returns:

The value of the plugin property for the specified plugin.

Throws:

IllegalArgumentException - If plugin is not a plugin of this manager.

See Also:

DynamicVariablesTable.getProperty(Object,String,String)