Platform SDK Java 8.5 API Reference

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

java.lang.Object
  extended by com.genesyslab.platform.configuration.protocol.metadata.CfgDescription
      extended by com.genesyslab.platform.configuration.protocol.metadata.CfgDescriptionClass
Direct Known Subclasses:
CfgDescriptionObject, CfgDescriptionStructure

public abstract class CfgDescriptionClass
extends CfgDescription

CfgDescriptionClass abstract class is the base class for all the kinds of descriptive configuration classes, namely:

Only two of them, CfgDescriptionObject and CfgDescriptionObjectDelta are the kinds that can be employed as an Configuration Protocol message attribute, all of them serve the role of nested types inside of the CfgDescriptionObject and CfgDescriptionObjectDelta objects as the descriptive classes that referenced by reference attributes.

See Also:
CfgDescriptionObject, CfgDescriptionStructure, CfgDescriptionObjectDelta, CfgDescriptionStructureDelta

Field Summary
 
Fields inherited from class com.genesyslab.platform.configuration.protocol.metadata.CfgDescription
baseComparer
 
Method Summary
 CfgDescriptionAttribute getAttribute(java.lang.String schemaName)
          Gets an attribute of a descriptive class' instance using attribute's schema name as criteria.
 CfgDescriptionAttribute getAttributeByName(java.lang.String attributeName)
          Gets an attribute of a descriptive class' instance using attribute name as criteria.
 java.util.Collection<CfgDescriptionAttribute> getAttributes()
          Gets the sequence of attributes, a particular descriptive class instance consists of.
 CfgClassType getClassEnum()
          Gets corresponding value from CfgClassType enum for a particular CfgDescriptionClass descriptive class' instance.
 ICfgClassOperationalInfo getDelta()
          Gets delta description (ICfgClassOperationalInfo) for a particular descriptive class' instance.
 CfgDescriptionAttribute getDeltaListAttribute(java.lang.String mappingName, CfgOperation operation)
           
 CfgKeysComparer getEqualityComparer()
           
 java.util.Collection<CfgDescriptionAttribute> getKeys()
          Gets the sequence of key attributes for a particular instance of descriptive class.
 java.util.List<org.w3c.dom.Node> getKeys(org.w3c.dom.Node clazz)
          Deprecated. 
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

getClassEnum

public CfgClassType getClassEnum()
Gets corresponding value from CfgClassType enum for a particular CfgDescriptionClass descriptive class' instance.


getAttributes

public java.util.Collection<CfgDescriptionAttribute> getAttributes()
Gets the sequence of attributes, a particular descriptive class instance consists of.

Returns:
class' attributes

getKeys

public java.util.Collection<CfgDescriptionAttribute> getKeys()
Gets the sequence of key attributes for a particular instance of descriptive class.

Returns:
class' key attributes

getAttributeByName

public CfgDescriptionAttribute getAttributeByName(java.lang.String attributeName)
Gets an attribute of a descriptive class' instance using attribute name as criteria.

Parameters:
attributeName - Used to indicate name of an attribute
Returns:
either an attribute of a descriptive class' instance or null if the attribute is not found

getAttribute

public CfgDescriptionAttribute getAttribute(java.lang.String schemaName)
Gets an attribute of a descriptive class' instance using attribute's schema name as criteria.

Parameters:
schemaName - Used to indicate schema name of an attribute
Returns:
either an attribute of a descriptive class' instance as CfgDescriptionAttribute, or null if the attribute is not found

getKeys

@Deprecated
public java.util.List<org.w3c.dom.Node> getKeys(org.w3c.dom.Node clazz)
Deprecated. 


getDelta

public ICfgClassOperationalInfo getDelta()
Gets delta description (ICfgClassOperationalInfo) for a particular descriptive class' instance. Returns null if the instance does not have corresponding delta defined.


getEqualityComparer

public CfgKeysComparer getEqualityComparer()

getDeltaListAttribute

public CfgDescriptionAttribute getDeltaListAttribute(java.lang.String mappingName,
                                                     CfgOperation operation)

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.