com.ibm.wbi.install
Class PluginDescriptor

java.lang.Object
  |
  +--com.ibm.wbi.install.PluginDescriptor

public class PluginDescriptor
extends java.lang.Object

An object that describes the attributes of the plugin. This object contains an associated DatabaseSection that holds all of the appropriate information. Essentially, this object tailors the interface of a DatabaseSection to provide the specific information associated with plugins.


Field Summary
static java.lang.String COPYRIGHT
          IBM copyright information.
 
Constructor Summary
PluginDescriptor(DatabaseSection section)
          Construct the plugin descriptor with the specified attributes.
PluginDescriptor(com.ibm.wbi.util.FileElementParser parser)
          Construct the plugin descriptor passing it a FileElementParser that can read and find the appropriate attributes from a *.reg file
 
Method Summary
 java.lang.String getDescription()
          Get the description of the plugin.
 java.lang.String getDescriptiveName()
          Get the descriptive name of the plugin.
 int getMajorVersion()
          Get the major version number of the plugin.
 int getMinorVersion()
          Get the minor version number of the plugin.
 java.lang.String getPluginName()
          Get the fully-qualified class name of the plugin.
 boolean isEnabled()
          Is the plugin enabled?
 void setEnabled(boolean status)
          Set the status of the plugin.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
IBM copyright information.
Constructor Detail

PluginDescriptor

public PluginDescriptor(DatabaseSection section)
Construct the plugin descriptor with the specified attributes.
Parameters:
section - The database section that contains all the descriptive information about the plugin. Only DatabaseSections with the property "Plugin" with a true value can be associated with PluginDescriptors.

PluginDescriptor

public PluginDescriptor(com.ibm.wbi.util.FileElementParser parser)
                 throws com.ibm.wbi.install.PluginInstallException
Construct the plugin descriptor passing it a FileElementParser that can read and find the appropriate attributes from a *.reg file
Parameters:
parser - The file element parserplugin to create the descriptor from.
Method Detail

getMajorVersion

public int getMajorVersion()
Get the major version number of the plugin.
Returns:
The major version number.

getMinorVersion

public int getMinorVersion()
Get the minor version number of the plugin.
Returns:
The minor version number.

getPluginName

public java.lang.String getPluginName()
Get the fully-qualified class name of the plugin.
Returns:
The plugin class name.

getDescriptiveName

public java.lang.String getDescriptiveName()
Get the descriptive name of the plugin.
Returns:
The descriptive name.

getDescription

public java.lang.String getDescription()
Get the description of the plugin.
Returns:
The description.

isEnabled

public boolean isEnabled()
Is the plugin enabled?
Returns:
Enabled state.

setEnabled

public void setEnabled(boolean status)
Set the status of the plugin.
Parameters:
If - true plugin will be enabled or stays enabled, otherwise plugin will be disabled or stays disabled.