org.opencms.ade.configuration
Interface I_CmsConfigurationObject<X extends I_CmsConfigurationObject<X>>

Type Parameters:

X - the configuration object type which can be merged

All Known Implementing Classes:

CmsFunctionReference, CmsModelPageConfig, CmsPropertyConfig, CmsResourceTypeConfig

public interface I_CmsConfigurationObject<X extends I_CmsConfigurationObject<X>>

Interface for a single named configuration object that can either be merged with other configuration objects or disable a configuration object with the same name.

Since:

8.0.1

Version:

$Revision: 1.0$

Author:

Georg Westenberger

Field Summary

static int

DEFAULT_ORDER Default order constant for module configurations.

Method Summary

java.lang.String	getKey() The name of the configuration object.
boolean	isDisabled() If true, this configuration object will disable an inherited configuration object of the same name.
X	merge(X child) Merges this configuration object with a child configuration object.

Field Detail

DEFAULT_ORDER

static final int DEFAULT_ORDER

Default order constant for module configurations.

See Also:

Constant Field Values

Method Detail

getKey

java.lang.String getKey()

The name of the configuration object.

This name should be unique for each single configuration

Returns:

the name

isDisabled

boolean isDisabled()

If true, this configuration object will disable an inherited configuration object of the same name.

Returns:

true if this configuration object is marked as "disabled"

merge

X merge(X child)

Merges this configuration object with a child configuration object.

Parameters:

child - the child configuration object

Returns:

the merged configuration objects