Platform SDK Java 8.5 API Reference

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

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

public abstract class CfgDescription
extends java.lang.Object

CfgDescription abstract class is the base class for any kind of descriptive classes, or in other words, any descriptive class is a descendant of CfgDescription class and inherits CfgDescription's interface. There are the following base kinds CfgDescription descendants classes:

See Also:
CfgDescriptionClass, CfgDescriptionAttribute, CfgDescriptionEnum

Field Summary
protected  CfgComparer baseComparer
           
 
Method Summary
protected  void addTypeToMask(CfgTypeMask value)
           
 CfgComparer getComparer()
           
 int getIndex()
          Gets the sequence number of descriptive object.
 java.lang.String getLocalizedName()
          Gets localized name of descriptive object.
 java.lang.String getName()
          Gets the name of descriptive object.
static CfgNameComparer getNameComparer()
           
 int getProtocolVersion()
          Gets protocol version the configuration data type was introduced in.
 int getTypeBitMask()
          Returns the descriptive objects' bit-mask combination of its actual cfg types.
 java.util.EnumSet<CfgTypeMask> getTypeMask()
          Deprecated. 
 java.lang.String getTypeMaskString()
          Returns string representation of the descriptive objects' type mask.
It is usable for logging.
 boolean isCfgType(CfgTypeMask value)
          Checks if the descriptive object instance belongs to a particular cfg type or a combination of cfg types.
 boolean isCfgType(java.util.EnumSet<CfgTypeMask> value)
          Deprecated. 
 boolean isCfgType(int value)
          Checks if the descriptive object instance belongs to a particular cfg type or a combination of cfg types.
protected abstract  void setComparer()
           
protected  void setComparer(CfgComparer value)
           
protected abstract  void setTypeMask()
          Sets type mask for descriptive object.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

baseComparer

protected CfgComparer baseComparer
Method Detail

getName

public java.lang.String getName()
Gets the name of descriptive object.


getIndex

public int getIndex()
Gets the sequence number of descriptive object.

Note: this method is for internal use only.


getLocalizedName

public java.lang.String getLocalizedName()
Gets localized name of descriptive object.


getNameComparer

public static CfgNameComparer getNameComparer()

getComparer

public CfgComparer getComparer()

setComparer

protected void setComparer(CfgComparer value)

getProtocolVersion

public int getProtocolVersion()
Gets protocol version the configuration data type was introduced in.


isCfgType

public boolean isCfgType(CfgTypeMask value)
Checks if the descriptive object instance belongs to a particular cfg type or a combination of cfg types.

Parameters:
value - one of or "or" combination of the types defined in CfgTypeMask enumeration with CfgTypeMask.getCfgType() values.
Returns:
boolean value indicating if descriptive object belongs to a cfg type (or combination of cfg types) provided by the "value" parameter.

isCfgType

@Deprecated
public boolean isCfgType(java.util.EnumSet<CfgTypeMask> value)
Deprecated. 


isCfgType

public boolean isCfgType(int value)
Checks if the descriptive object instance belongs to a particular cfg type or a combination of cfg types.

Parameters:
value - one of or "or" combination of the types defined in CfgTypeMask enumeration with CfgTypeMask.getCfgType() values.
Returns:
boolean value indicating if descriptive object belongs to a cfg type (or combination of cfg types) provided by the "value" parameter.
See Also:
CfgTypeMask.getCfgType()

setTypeMask

protected abstract void setTypeMask()
Sets type mask for descriptive object.


setComparer

protected abstract void setComparer()

getTypeMask

@Deprecated
public java.util.EnumSet<CfgTypeMask> getTypeMask()
Deprecated. 

Note: external modifications of this set do not affect actual mapping.
This set is not a main container of the types map starting from PSDK 8.1.4.

See Also:
getTypeBitMask()

getTypeMaskString

public java.lang.String getTypeMaskString()
Returns string representation of the descriptive objects' type mask.
It is usable for logging.

Returns:
string with readable names of the enabled types

addTypeToMask

protected void addTypeToMask(CfgTypeMask value)

getTypeBitMask

public int getTypeBitMask()
Returns the descriptive objects' bit-mask combination of its actual cfg types.

Returns:
value one of or "or" combination of the types defined in CfgTypeMask enumeration with CfgTypeMask.getCfgType() values.
See Also:
CfgTypeMask.getCfgType()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

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.