Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgEnumerator

java.lang.Object
  extended by com.genesyslab.platform.applicationblocks.com.CfgBase
      extended by com.genesyslab.platform.applicationblocks.com.CfgObject
          extended by com.genesyslab.platform.applicationblocks.com.objects.CfgEnumerator
All Implemented Interfaces:
ICfgBase, ICfgObject, java.lang.Cloneable

public class CfgEnumerator
extends CfgObject

CfgEnumerator objects are available enumerations, such as MediaType, Service Type, and others.

The table below provides a description of predefined CfgEnumerator objects (some fields are omitted for simplicity):

Predefined CfgEnumerator Objects
DBID Tenant Name Display name Type Description
101 1(101) MediaType Media Type 1 Defines all available Media Types
102 1(101) ServiceType Service Type 1 Defines all available Service Types
103 1(101) CustomerSegment Customer Segment 1 Defines all available Customer Segments
104 1(101) IVR Text To Speech Used IVR Text To Speech Used 1 Defines IVR Text To Speech Used
105 1(101) IVR Speech Recognition Used IVR Speech Recognition Used 1 Defines IVR Speech Recognition Used
106 1(101) IVR Application Name IVR Application Name 1 Defines IVR Application Name
107 1(101) IVR Technical Result IVR Technical Result 1 Defines IVR Technical Result
108 1(101) IVR Technical Result Reason IVR Technical Result Reason 1 Defines IVR Technical Result Reason
109 1(101) Case ID Case ID 1 Defines Case ID
110 1(101) Business Result Business Result 1 Defines Business Result
111 1(101) Root Interaction ID Root Interaction ID 1 Root Interaction ID
112 1(101) InteractionType Interaction Type 1 Predefined list of interaction types supported by contact center
113 1(101) InteractionSubtype Interaction Subtype 1 Predefined list of interaction subtypes supported by contact center
114 1(101) CategoryStructure Category Structure 4 Customer defined
115 1(101) ScreeningRules Screening Rules 4 Customer defined
116 1(101) EmailAccounts Email Accounts 4 Customer defined
117 1(101) StopProcessingReason StopProcessing Reason 1 Predefined, extended by customer
118 1(101) Language Language 1 Extended by customer
119 1(101) DispositionCode Disposition Code 1 Customer defined
120 1(101) ReasonCode Reason Code 1 Customer defined
121 1(101) InteractionAttributes Interaction Attributes 1 List of predefined interaction attributes
122 1(101) ContactAttributes Contact Attributes 1 List of predefined contact attributes

In the GUI representation, the name ___Enumerator___ was replaced with ___Business Attribute___

Deletion of Enumerator X will cause the following events set out in the order of arrival:



See also:

CfgDeltaEnumerator

CfgEnumeratorValue


Field Summary
static CfgObjectType OBJECT_TYPE
           
 
Constructor Summary
CfgEnumerator(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgEnumerator(IConfService confService, ConfObject objData, boolean isSaved, java.lang.Object[] additionalParameters)
          This constructor is intended for creation of objects from configuration protocol messages.
CfgEnumerator(IConfService confService, org.w3c.dom.Node xmlData, java.lang.Object[] additionalParameters)
          This constructor is intended for creation of objects from configuration protocol messages.
 
Method Summary
 java.lang.Integer getDBID()
          An identifier of this object in the Configuration Database.
 java.lang.String getDescription()
          A pointer to the description of the enumerator.
 java.lang.String getDisplayName()
          A pointer to the display name of the enumerator to be shown on GUI and in reports.
 java.lang.String getName()
          A pointer to the system name of the enumerator to be used primarily by Genesys applications.
 CfgObjectState getState()
          Current object state.
 CfgTenant getTenant()
          A unique identifier of the CfgTenant to which this enumerator is allocated.
 java.lang.Integer getTenantDBID()
          Retrieves the dbid of the object that is being linked to by the Tenant property.
 CfgEnumeratorType getType()
          A type of the enumerator that enumerator belongs to.
 KeyValueCollection getUserProperties()
          A pointer to the list of user-defined properties.Parameter userProperties has the following structure: Each key-value pair of the primary list (TKVList *userProperties) uses the key for the name of a user-defined section, and the value for a secondary list, that also has the TKVList structure and specifies the properties defined within that section.
 void save()
          Synchronizes changes in the class with Configuration Server.
 void setDBID(java.lang.Integer value)
          An identifier of this object in the Configuration Database.
 void setDescription(java.lang.String value)
          A pointer to the description of the enumerator.
 void setDisplayName(java.lang.String value)
          A pointer to the display name of the enumerator to be shown on GUI and in reports.
 void setName(java.lang.String value)
          A pointer to the system name of the enumerator to be used primarily by Genesys applications.
 void setState(CfgObjectState value)
          Current object state.
 void setTenant(CfgTenant value)
          A unique identifier of the CfgTenant to which this enumerator is allocated.
 void setTenantDBID(int dbid)
          A unique identifier of the CfgTenant to which this enumerator is allocated.
 void setType(CfgEnumeratorType value)
          A type of the enumerator that enumerator belongs to.
 void setUserProperties(KeyValueCollection value)
          A pointer to the list of user-defined properties.Parameter userProperties has the following structure: Each key-value pair of the primary list (TKVList *userProperties) uses the key for the name of a user-defined section, and the value for a secondary list, that also has the TKVList structure and specifies the properties defined within that section.
 
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgObject
clone, delete, doSetFolderId, ensureDataBackup, getFolderId, getObjectDbid, getObjectPath, getObjectType, refresh, reloadObjectWithNewData, reloadObjectWithNewData, removeAccount, resetDataBackup, retrieveAccountPermissions, retrieveACL, retrievePermissions, setAccountPermissions, setAccountPermissions, setFolderId, update, updateACL
 
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgBase
equals, flushChildrenContent, getConfigurationService, getData, getEndpoint, getLinkListCollection, getLinkValue, getLogger, getMetaData, getParent, getProperty, getProperty, getProperty, getRawObjectData, hashCode, initStruct, isSaved, lockObject, resolveLink, setProperty, toString, toStringProperties, toXml, updateChildrenSavedState
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.genesyslab.platform.applicationblocks.com.ICfgBase
getEndpoint, getProperty, getRawObjectData, setProperty, toXml
 

Field Detail

OBJECT_TYPE

public static final CfgObjectType OBJECT_TYPE
Constructor Detail

CfgEnumerator

public CfgEnumerator(IConfService confService,
                     ConfObject objData,
                     boolean isSaved,
                     java.lang.Object[] additionalParameters)
This constructor is intended for creation of objects from configuration protocol messages. It is internally used by COM AB for objects deserialization.

Parameters:
confService - configuration service instance
objData - configuration protocol object data structure
isSaved - indicator of the object saved state
additionalParameters - additional parameters from configuration protocol message

CfgEnumerator

public CfgEnumerator(IConfService confService,
                     org.w3c.dom.Node xmlData,
                     java.lang.Object[] additionalParameters)
This constructor is intended for creation of objects from configuration protocol messages. It is internally used by COM AB for objects deserialization.

Parameters:
confService - configuration service instance
xmlData - XML object containing object data
additionalParameters - additional parameters from configuration protocol message

CfgEnumerator

public CfgEnumerator(IConfService confService)
This constructor is intended for creation of detached objects.

Parameters:
confService - configuration service instance
Method Detail

save

public void save()
          throws ConfigException
Synchronizes changes in the class with Configuration Server.

Specified by:
save in interface ICfgObject
Overrides:
save in class CfgObject
Throws:
ConfigException - in case of protocol level exception, data transformation, or server side constraints

getDBID

public final java.lang.Integer getDBID()
An identifier of this object in the Configuration Database. Generated by Configuration Server and is unique within an object type. Identifiers of deleted objects are not used again. Read-only.

Returns:
property value or null

setDBID

public final void setDBID(java.lang.Integer value)
An identifier of this object in the Configuration Database. Generated by Configuration Server and is unique within an object type. Identifiers of deleted objects are not used again. Read-only.

Parameters:
value - new property value
See Also:
getDBID()

getTenant

public final CfgTenant getTenant()
A unique identifier of the CfgTenant to which this enumerator is allocated. Mandatory. Once specified, cannot be changed.

Returns:
instance of referred object or null

setTenant

public final void setTenant(CfgTenant value)
A unique identifier of the CfgTenant to which this enumerator is allocated. Mandatory. Once specified, cannot be changed.

Parameters:
value - new property value
See Also:
getTenant()

setTenantDBID

public final void setTenantDBID(int dbid)
A unique identifier of the CfgTenant to which this enumerator is allocated. Mandatory. Once specified, cannot be changed.

Parameters:
dbid - DBID identifier of referred object
See Also:
getTenant()

getTenantDBID

public final java.lang.Integer getTenantDBID()
Retrieves the dbid of the object that is being linked to by the Tenant property.

Returns:
DBID identifier of referred object or null

getName

public final java.lang.String getName()
A pointer to the system name of the enumerator to be used primarily by Genesys applications. Mandatory. Must be unique within the tenant environment. Once specified, can not be changed.

Returns:
property value or null

setName

public final void setName(java.lang.String value)
A pointer to the system name of the enumerator to be used primarily by Genesys applications. Mandatory. Must be unique within the tenant environment. Once specified, can not be changed.

Parameters:
value - new property value
See Also:
getName()

getDescription

public final java.lang.String getDescription()
A pointer to the description of the enumerator.

Returns:
property value or null

setDescription

public final void setDescription(java.lang.String value)
A pointer to the description of the enumerator.

Parameters:
value - new property value
See Also:
getDescription()

getState

public final CfgObjectState getState()
Current object state. Mandatory. Refer to CfgObjectState

Returns:
property value or null

setState

public final void setState(CfgObjectState value)
Current object state. Mandatory. Refer to CfgObjectState

Parameters:
value - new property value
See Also:
getState()

getUserProperties

public final KeyValueCollection getUserProperties()
A pointer to the list of user-defined properties.Parameter userProperties has the following structure: Each key-value pair of the primary list (TKVList *userProperties) uses the key for the name of a user-defined section, and the value for a secondary list, that also has the TKVList structure and specifies the properties defined within that section.

Returns:
property value or null

setUserProperties

public final void setUserProperties(KeyValueCollection value)
A pointer to the list of user-defined properties.Parameter userProperties has the following structure: Each key-value pair of the primary list (TKVList *userProperties) uses the key for the name of a user-defined section, and the value for a secondary list, that also has the TKVList structure and specifies the properties defined within that section.

Parameters:
value - new property value
See Also:
getUserProperties()

getType

public final CfgEnumeratorType getType()
A type of the enumerator that enumerator belongs to. See CfgEnumeratorType

Returns:
property value or null

setType

public final void setType(CfgEnumeratorType value)
A type of the enumerator that enumerator belongs to. See CfgEnumeratorType

Parameters:
value - new property value
See Also:
getType()

getDisplayName

public final java.lang.String getDisplayName()
A pointer to the display name of the enumerator to be shown on GUI and in reports. Mandatory.

Returns:
property value or null

setDisplayName

public final void setDisplayName(java.lang.String value)
A pointer to the display name of the enumerator to be shown on GUI and in reports. Mandatory.

Parameters:
value - new property value
See Also:
getDisplayName()

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.