org.opencms.ade.configuration

Class CmsModelPageConfig

java.lang.Object

org.opencms.ade.configuration.CmsModelPageConfig

All Implemented Interfaces:

java.lang.Cloneable, I_CmsConfigurationObject<CmsModelPageConfig>

public class CmsModelPageConfig
extends java.lang.Object
implements I_CmsConfigurationObject<CmsModelPageConfig>, java.lang.Cloneable

This class contains the model page configuration for a sitemap region.

Since:

8.0.0

Version:

$Revision: 1.0 $

Author:

Georg Westenberger

Field Summary

Fields inherited from interface org.opencms.ade.configuration.I_CmsConfigurationObject

DEFAULT_ORDER

Constructor Summary

Constructors

Constructor and Description
CmsModelPageConfig(CmsResource res, boolean isDefault, boolean isDisabled) Creates a new model page configuration bean.

Method Summary

Modifier and Type	Method and Description
CmsModelPageConfig	clone()
java.lang.String	getKey() The name of the configuration object.
CmsResource	getResource() Gets the model page resource.
boolean	isDefault() Returns true if this is a default model page.
boolean	isDisabled() Returns true if this entry disables the model page.
CmsModelPageConfig	merge(CmsModelPageConfig child) Merges this configuration object with a child configuration object.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CmsModelPageConfig

public CmsModelPageConfig(CmsResource res,
                          boolean isDefault,
                          boolean isDisabled)

Creates a new model page configuration bean.

Parameters:

res - the model page resource

isDefault - true if this is a default model page

isDisabled - true if this is a disabled model page

Method Detail

clone

public CmsModelPageConfig clone()

Overrides:

clone in class java.lang.Object

See Also:

Object.clone()

getKey

public java.lang.String getKey()

Description copied from interface: I_CmsConfigurationObject

The name of the configuration object.

This name should be unique for each single configuration

Specified by:

getKey in interface I_CmsConfigurationObject<CmsModelPageConfig>

Returns:

the name

See Also:

I_CmsConfigurationObject.getKey()

getResource

public CmsResource getResource()

Gets the model page resource.

Returns:

the model page resource

isDefault

public boolean isDefault()

Returns true if this is a default model page.

Returns:

true if this is a default model page

isDisabled

public boolean isDisabled()

Returns true if this entry disables the model page.

Specified by:

isDisabled in interface I_CmsConfigurationObject<CmsModelPageConfig>

Returns:

true if this entry disables the model page

merge

public CmsModelPageConfig merge(CmsModelPageConfig child)

Description copied from interface: I_CmsConfigurationObject

Merges this configuration object with a child configuration object.

Specified by:

merge in interface I_CmsConfigurationObject<CmsModelPageConfig>

Parameters:

child - the child configuration object

Returns:

the merged configuration objects

See Also:

I_CmsConfigurationObject.merge(org.opencms.ade.configuration.I_CmsConfigurationObject)