Platform SDK Java 8.5 API Reference

com.genesyslab.platform.configuration.protocol.metadata
Class CfgDescriptionAttribute

java.lang.Object
  extended by com.genesyslab.platform.configuration.protocol.metadata.CfgDescription
      extended by com.genesyslab.platform.configuration.protocol.metadata.CfgDescriptionAttribute
All Implemented Interfaces:
ICfgEnum<CfgObjectProperty>
Direct Known Subclasses:
CfgDescriptionAttributePrimitive, CfgDescriptionAttributeReference

public abstract class CfgDescriptionAttribute
extends CfgDescription
implements ICfgEnum<CfgObjectProperty>

CfgDescriptionAttribute abstract class is the base descriptive class for configuration protocol attributes.

CfgDescriptionAttribute class is derived from CfgDescription class. CfgDescriptionAttribute also inherits ICfgEnum<T> interface realizing the 'Optional Feature' pattern. The whole set of the configuration attributes is listed in the CfgObjectProperty enumeration. In case of CfgDescriptionAttribute, ICfgEnum<T>.getCfgEnum() implementation returns the enumeration value for the configuration object a particular CfgDescriptionAttribute class' instance describes.

CfgDescriptionAttribute is the base class for the following basic kinds of descriptive attribute classes:

See Also:
CfgObjectProperty, CfgDescriptionEnum, ICfgEnum, CfgDescriptionAttributePrimitive, CfgDescriptionAttributeReference, CfgDescriptionAttributeKvList, CfgOperation

Field Summary
 
Fields inherited from class com.genesyslab.platform.configuration.protocol.metadata.CfgDescription
baseComparer
 
Method Summary
 CfgObjectProperty getCfgEnum()
          Gets corresponding value from CfgObjectProperty enumeration for a particular CfgDescriptionAttribute descriptive class' instance.
 java.lang.Long getConst()
           
 java.lang.String getMappingName()
          Returns attribute's mapping name.
 CfgOperation getOperation()
          Indicates what kind of operation is intended (in case of deltas) or allowed (in case of subjects) to be performed, using the attribute (in case of deltas) or on attribute (in case of subjects).
 java.lang.String getPackName()
           
 CfgDescriptionClass getParent()
          Returns description class (CfgDescriptionClass), the attribute belongs to.
 java.lang.String getSchemaName()
          Gets XML schema name for an attribute descriptive instance.
abstract  java.lang.Object getValue(org.w3c.dom.Element parentElement)
          Deprecated. 
 boolean isKey()
          Indicates if the attribute serves the role of a key attribute.
 boolean isPackCustom()
           
 boolean isUnpackCustom()
           
protected  void setComparer()
           
protected  void setTypeMask()
          Sets type mask for descriptive object.
 
Methods inherited from class com.genesyslab.platform.configuration.protocol.metadata.CfgDescription
addTypeToMask, getComparer, getIndex, getLocalizedName, getName, getNameComparer, getProtocolVersion, getTypeBitMask, getTypeMask, getTypeMaskString, isCfgType, isCfgType, isCfgType, setComparer, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

isPackCustom

public boolean isPackCustom()

isUnpackCustom

public boolean isUnpackCustom()

getPackName

public java.lang.String getPackName()

getConst

public java.lang.Long getConst()

getParent

public CfgDescriptionClass getParent()
Returns description class (CfgDescriptionClass), the attribute belongs to.

See Also:
CfgDescriptionClass

isKey

public boolean isKey()
Indicates if the attribute serves the role of a key attribute.


getMappingName

public java.lang.String getMappingName()
Returns attribute's mapping name.


getSchemaName

public java.lang.String getSchemaName()
Gets XML schema name for an attribute descriptive instance.


getOperation

public CfgOperation getOperation()
Indicates what kind of operation is intended (in case of deltas) or allowed (in case of subjects) to be performed, using the attribute (in case of deltas) or on attribute (in case of subjects). The whole set of operations is listed in the CfgOperation enumeration.

See Also:
CfgOperation

getCfgEnum

public CfgObjectProperty getCfgEnum()
Gets corresponding value from CfgObjectProperty enumeration for a particular CfgDescriptionAttribute descriptive class' instance.

Specified by:
getCfgEnum in interface ICfgEnum<CfgObjectProperty>
Returns:
Corresponding enum value
See Also:
CfgObjectProperty

getValue

@Deprecated
public abstract java.lang.Object getValue(org.w3c.dom.Element parentElement)
Deprecated. 


setTypeMask

protected void setTypeMask()
Description copied from class: CfgDescription
Sets type mask for descriptive object.

Specified by:
setTypeMask in class CfgDescription

setComparer

protected void setComparer()
Specified by:
setComparer in class CfgDescription

Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.