org.opencms.ade.configuration

类 CmsFunctionReference

java.lang.Object

org.opencms.ade.configuration.CmsFunctionReference

所有已实现的接口:

I_CmsConfigurationObject<CmsFunctionReference>

public class CmsFunctionReference
extends java.lang.Object
implements I_CmsConfigurationObject<CmsFunctionReference>

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

字段概要

从接口继承的字段 org.opencms.ade.configuration.I_CmsConfigurationObject

DEFAULT_ORDER

构造器概要

构造器

构造器和说明
CmsFunctionReference(java.lang.String name, CmsUUID structureId, int order) Creates a new function reference.

方法概要

方法

限定符和类型	方法和说明
java.lang.String	getKey() The name of the configuration object.
java.lang.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.

从类继承的方法 java.lang.Object

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

构造器详细资料

CmsFunctionReference

public CmsFunctionReference(java.lang.String name,
                    CmsUUID structureId,
                    int order)

Creates a new function reference.

参数:

name - the name of the function reference

structureId - the structure id of the function

order - the number used for sorting the function references

方法详细资料

getKey

public java.lang.String getKey()

从接口复制的说明: I_CmsConfigurationObject

The name of the configuration object.

This name should be unique for each single configuration

指定者:

getKey 在接口中 I_CmsConfigurationObject<CmsFunctionReference>

返回:

the name

另请参阅:

I_CmsConfigurationObject.getKey()

getName

public java.lang.String getName()

Returns the name of the function reference.

返回:

the name of the function reference

getOrder

public int getOrder()

The order information for sorting the function references.

返回:

the order information

getStructureId

public CmsUUID getStructureId()

Returns the structure id of the dynamic function resource.

返回:

the structure id of the function

isDisabled

public boolean isDisabled()

从接口复制的说明: I_CmsConfigurationObject

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

指定者:

isDisabled 在接口中 I_CmsConfigurationObject<CmsFunctionReference>

返回:

true if this configuration object is marked as "disabled"

另请参阅:

I_CmsConfigurationObject.isDisabled()

merge

public CmsFunctionReference merge(CmsFunctionReference child)

从接口复制的说明: I_CmsConfigurationObject

Merges this configuration object with a child configuration object.

指定者:

merge 在接口中 I_CmsConfigurationObject<CmsFunctionReference>

参数:

child - the child configuration object

返回:

the merged configuration objects

另请参阅:

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