Platform SDK Java 8.5 API Reference

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

java.lang.Object
  extended by com.genesyslab.platform.configuration.protocol.metadata.CfgDescription
      extended by com.genesyslab.platform.configuration.protocol.metadata.CfgDescriptionClass
          extended by com.genesyslab.platform.configuration.protocol.metadata.CfgDescriptionStructure
All Implemented Interfaces:
ICfgEnum<CfgStructureType>
Direct Known Subclasses:
CfgDescriptionSchema, CfgDescriptionStructureDelta

public class CfgDescriptionStructure
extends CfgDescriptionClass
implements ICfgEnum<CfgStructureType>

CfgDescriptionStructure class is descriptive class for configuration protocol structures.

CfgDescriptionStructure class is derived from the the base CfgDescriptionClass class. CfgDescriptionStructure also implements ICfgEnum<CfgStructureType> interface. The whole set of the configuration structures' is listed in the CfgStructureType enum. In case of CfgDescriptionStructure, ICfgEnum.getCfgEnum() implementation returns the enum value of the configuration structure a particular CfgDescriptionStructure class' instance describes.

See Also:
CfgStructureType, CfgDescriptionObject, CfgDescriptionEnum, ICfgEnum

Field Summary
 
Fields inherited from class com.genesyslab.platform.configuration.protocol.metadata.CfgDescription
baseComparer
 
Constructor Summary
protected CfgDescriptionStructure(Cfglibschema.TypeInfo typeInfo, int enumCode, int protocolId)
           
protected CfgDescriptionStructure(java.lang.String name, int enumCode, java.lang.String enumLiteral, int protocolId)
           
 
Method Summary
 CfgDescriptionStructure getAlias()
           
 java.lang.String getAliasName()
           
 CfgStructureType getCfgEnum()
          Gets corresponding value from CfgStructureType enum for a particular CfgDescriptionStructure descriptive class' instance.
protected  void setTypeMask()
          Sets type mask for descriptive object.
 
Methods inherited from class com.genesyslab.platform.configuration.protocol.metadata.CfgDescriptionClass
getAttribute, getAttributeByName, getAttributes, getClassEnum, getDelta, getDeltaListAttribute, getEqualityComparer, getKeys, getKeys, setComparer
 
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
 

Constructor Detail

CfgDescriptionStructure

protected CfgDescriptionStructure(java.lang.String name,
                                  int enumCode,
                                  java.lang.String enumLiteral,
                                  int protocolId)

CfgDescriptionStructure

protected CfgDescriptionStructure(Cfglibschema.TypeInfo typeInfo,
                                  int enumCode,
                                  int protocolId)
Method Detail

getAlias

public CfgDescriptionStructure getAlias()

getAliasName

public java.lang.String getAliasName()

getCfgEnum

public CfgStructureType getCfgEnum()
Gets corresponding value from CfgStructureType enum for a particular CfgDescriptionStructure descriptive class' instance.

Specified by:
getCfgEnum in interface ICfgEnum<CfgStructureType>
Returns:
Corresponding enum value

setTypeMask

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

Overrides:
setTypeMask in class CfgDescriptionClass

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.