org.opencms.configuration
Interface I_CmsConfigurationParameterHandler

All Known Subinterfaces:

I_CmsDialogHandler, I_CmsDirectEditProvider, I_CmsPasswordHandler, I_CmsPreEditorActionDefinition, I_CmsResourceLoader, I_CmsResourceType, I_CmsXmlConfiguration

All Known Implementing Classes:

A_CmsDirectEditProvider, A_CmsPreEditorActionDefinition, A_CmsRepository, A_CmsResourceType, A_CmsResourceTypeFolderBase, A_CmsResourceTypeLinkParseable, A_CmsXmlConfiguration, CmsAdvancedDirectEditProvider, CmsConfigurationManager, CmsDefaultPasswordHandler, CmsDelete, CmsDialogProperty, CmsDirectEditDefaultProvider, CmsDirectEditJQueryProvider, CmsDirectEditJspIncludeProvider, CmsDirectEditTextButtonProvider, CmsDumpLoader, CmsFlexDummyLoader, CmsGallerySearchIndex, CmsImageLoader, CmsImportExportConfiguration, CmsJspLoader, CmsLock, CmsModuleConfiguration, CmsPointerLoader, CmsPreEditorActionDefinitionXmlContent, CmsPropertyAdvanced, CmsPropertyCustom, CmsRecourceTypeFolderGallery, CmsRepository, CmsResourceTypeBinary, CmsResourceTypeFolder, CmsResourceTypeFolderExtended, CmsResourceTypeImage, CmsResourceTypeJsp, CmsResourceTypePlain, CmsResourceTypePointer, CmsResourceTypeUnknown, CmsResourceTypeUnknownFile, CmsResourceTypeUnknownFolder, CmsResourceTypeXmlAdeConfiguration, CmsResourceTypeXmlContainerPage, CmsResourceTypeXmlContent, CmsResourceTypeXmlPage, CmsScheduledJobInfo, CmsSearchConfiguration, CmsSearchIndex, CmsSystemConfiguration, CmsTestConfiguration, CmsToolbarDirectEditProvider, CmsVfsConfiguration, CmsWorkplaceConfiguration, CmsXmlContainerPageLoader, CmsXmlContentLoader, CmsXmlPageLoader

public interface I_CmsConfigurationParameterHandler

Used for classes that are configurable using <param name="name">value</param> in the XML configuration.

Such "param" nodes can be used to add some arbitrary names parameters to classes that otherwise share the same XML configuration.

Since:

6.0.0

Field Summary

static String	ADD_PARAMETER_METHOD The name of the addConfigurationParameter() method.
static String	INIT_CONFIGURATION_METHOD The name of the initConfiguration() method.

Method Summary

void	addConfigurationParameter(String paramName, String paramValue) Adds a configuration parameter to this parameter configurable class instance.
CmsParameterConfiguration	getConfiguration() Returns the parameters of this configurable class instance, or null if the class does not need any parameters.
void	initConfiguration() Initializes a configuration after all parameters have been added.

Field Detail

ADD_PARAMETER_METHOD

static final String ADD_PARAMETER_METHOD

The name of the addConfigurationParameter() method.

See Also:

Constant Field Values

INIT_CONFIGURATION_METHOD

static final String INIT_CONFIGURATION_METHOD

The name of the initConfiguration() method.

See Also:

Constant Field Values

Method Detail

addConfigurationParameter

void addConfigurationParameter(String paramName,
                               String paramValue)

Adds a configuration parameter to this parameter configurable class instance.

Parameters:

paramName - the name of the parameter

paramValue - the value for the parameter

getConfiguration

CmsParameterConfiguration getConfiguration()

Returns the parameters of this configurable class instance, or null if the class does not need any parameters.

Returns:

the parameters of this configurable class instance, or null if the class does not need any parameters

initConfiguration

void initConfiguration()
                       throws CmsConfigurationException

Initializes a configuration after all parameters have been added.

Throws:

CmsConfigurationException - if something goes wrong