Package org.opencms.ade.configuration

Class CmsFunctionReference

java.lang.Object

org.opencms.ade.configuration.CmsFunctionReference

All Implemented Interfaces:

I_CmsConfigurationObject<CmsFunctionReference>

public class CmsFunctionReference
extends Object
implements I_CmsConfigurationObject<CmsFunctionReference>

Bean for representing a named dynamic function reference from the configuration.

Field Summary

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

DEFAULT_ORDER

Constructor Summary

Constructors

Constructor	Description
CmsFunctionReference(String name, CmsUUID structureId, CmsUUID functionDefaultPageId, int order)	Creates a new function reference.

Method Summary

Modifier and Type	Method	Description
CmsUUID	getFunctionDefaultPageId()	Returns the function default page id.
String	getKey()	The name of the configuration object.
String	getName()	Returns the name of the function reference.
int	getOrder()	The order information for sorting the function references.
CmsUUID	getStructureId()	Returns the structure id of the dynamic function resource.
boolean	isDisabled()	If true, this configuration object will disable an inherited configuration object of the same name.
CmsFunctionReference	merge(CmsFunctionReference child)	Merges this configuration object with a child configuration object.

Methods inherited from class java.lang.Object

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

Constructor Details

CmsFunctionReference

public CmsFunctionReference(String name,
 CmsUUID structureId,
 CmsUUID functionDefaultPageId,
 int order)

Creates a new function reference.

Parameters:

name - the name of the function reference

structureId - the structure id of the function

functionDefaultPageId - the function default page id

order - the number used for sorting the function references

Method Details

getFunctionDefaultPageId

public CmsUUID getFunctionDefaultPageId()

Returns the function default page id.

Returns:

the function default page id

getKey

public 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<CmsFunctionReference>

Returns:

the name

See Also:

• I_CmsConfigurationObject.getKey()

getName

public String getName()

Returns the name of the function reference.

Returns:

the name of the function reference

getOrder

public int getOrder()

The order information for sorting the function references.

Returns:

the order information

getStructureId

public CmsUUID getStructureId()

Returns the structure id of the dynamic function resource.

Returns:

the structure id of the function

isDisabled

public boolean isDisabled()

Description copied from interface: I_CmsConfigurationObject

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

Specified by:

isDisabled in interface I_CmsConfigurationObject<CmsFunctionReference>

Returns:

true if this configuration object is marked as "disabled"

See Also:

• I_CmsConfigurationObject.isDisabled()

merge

public CmsFunctionReference merge(CmsFunctionReference child)

Description copied from interface: I_CmsConfigurationObject

Merges this configuration object with a child configuration object.

Specified by:

merge in interface I_CmsConfigurationObject<CmsFunctionReference>

Parameters:

child - the child configuration object

Returns:

the merged configuration objects

See Also:

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