debian man page for lire::config::plugin

Plugin(3pm)						  LogReport's Lire Documentation					       Plugin(3pm)

NAME
       Lire::Config::Plugin - Value object for plugin configuration.

SYNOPSIS
	 use Lire::Config::Plugin;

DESCRIPTION
       This configuration object hold the name of a selected plugin as well as its options.

   get_plugin()
       Returns the currently selected plugin.

   set_plugin( $plugin )
       Changes the selected plugin. If the selected plugin is changed, a new property set will be created from the plugin's defined properties.

   get_properties_spec()
       Returns the TypeSpec that is used to specify the plugin's properties.  This method will return an empty RecordSpec when the plugin didn't
       define any properties. One can also use the has_properties() method to check if the Plugin defined configuration properties.

   has_properties()
       Returns a boolean value indicating whether the current plugin is configurable.

   get_properties()
       Returns the Lire::Config::Dictionary object which hold the plugin configuration.

   as_value()
       Returns an hash reference with two keys : 'plugin' which contains the selected plugin and 'properties' which is an hash reference
       containing the plugin's properties.

   get( $name )
       Delegates to the Dictionary which contains the plugin's properties.

   set( $name, $value )
       Delegates to the Dictionary which contains the plugin's properties.

   is_set( $name )
       Delegates to the Dictionary which contains the plugin's properties.

Lire 2.1.1							    2006-07-23							       Plugin(3pm)