org.eclipse.higgins.configuration.api
Interface IConfigurableComponent

public interface IConfigurableComponent

Author:

mikemci

Method Summary

void	configure(Map mapGlobalSettings, String strComponentName, Map mapComponentSettings, ISettingDescriptor componentDescriptor, ISettingDescriptor globalDescriptor) Use name/value pairs in map objects to configure.
ISettingDescriptor	getComponentDescriptor()

Method Detail

configure

public void configure(Map mapGlobalSettings,
                      String strComponentName,
                      Map mapComponentSettings,
                      ISettingDescriptor componentDescriptor,
                      ISettingDescriptor globalDescriptor)
               throws Exception

Use name/value pairs in map objects to configure. The combination of values in mapGlobalSettings and mapComponentSettings must be sufficient to fully configure this component.

Parameters:

mapGlobalSettings - Settings related to this component, and to other components that might be referenced by this one.

strComponentName - String used to identify this component (e.g., for logging).

mapComponentSettings - Component-specific settings, possibly a subset extracted from mapGlobalSettings.

componentDescriptor - Component-specific setting descriptor

globalDescriptor - Setting descriptors related to this component and to other components that might be referenced by this one.

Throws:

Exception

getComponentDescriptor

public ISettingDescriptor getComponentDescriptor()