Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgEnumeratorValue

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.CfgEnumeratorValue
All Implemented Interfaces:
ICfgBase, ICfgObject, java.lang.Cloneable

public class CfgEnumeratorValue
extends CfgObject

CfgEnumeratorValue objects contain all of the values for all available enumerators.

The Following table specifies predefined CfgEnumeratorValue objects (some fields are omitted for simplicity) and ranges for each Enumerator:

Predefined CfgEnumeratorValue Objects and Their Ranges
DBID Enumerator Name Display name Is default? Description
100 101 Voice voice No Media Voice
101 101 Voip voip No Media Voice over IP
102 101 Email email No Media EMail
103 101 Vmail vmail No Media Voice Mail
104 101 Smail smail No Media Scanned Mail
105 101 Chat chat No Media Chat
106 101 Video video No Media Video
107 101 Cobrowsing cobrowsing No Media Cobrowsing
108 101 Whiteboard whiteboard No Media Whiteboard
109 101 Appsharing appsharing No Media Application Sharing
110 101 Webform webform No Media Web Form
111 101 Workitem workitem No Media Workitem
112 101 Callback callback No Media Callback
113 101 Fax fax No Media Fax
114 101 Imchat imchat No Media IMChat
115 101 Busevent busevent No Media Business Event
116 101 Alert alert No Media Alert
117 101 Sms sms No Media SMS
118 101 Any any Yes Media Any
119 101 Auxwork auxwork No Media AuxWork
200 102 Default default Yes Service Type Default
300 103 Default default Yes Customer Segment Default
350 104 Unknown unknown Yes IVR Text To Speech Used Default
353 104 Unknown unknown Yes IVR Speech Recognition Used Default
400 112 Inbound Inbound No Interactions received by contact center from outside clients
401 112 Outbound Outbound No Interactions sent from contact center to external clients
402 112 Internal Internal No Internal interactions between contact center correspondents
403 113 InboundNew Inbound New No New incoming email. Starts a new thread
404 113 InboundCustomerReply Customer Reply No Reply from a customer
405 113 InboundCollaborationReply Inbound Collaboration Reply No Reply from an external source
406 113 InboundNDR NDR No Error message sent back to the system by SMTP server chain
407 113 OutboundNew Outbound New No New message from Contact Center to a customer
408 113 OutboundReply Reply No Reply from Contact Center to a customer
409 113 OutboundAcknowledgement Acknowledgement No Ack message sent to customer by Contact Center
410 113 OutboundAutoResponse Auto Response No Automated reply from Contact Center to a customer
411 113 OutboundRedirect Redirect No Message redirect to an external resource. No reply expected.
412 113 OutboundCollaborationInvite Outbound Collaboration Invite No New message to an external resource
413 113 InternalCollaborationInvite Internal Collaboration Invite No New message to an internal resource
414 113 InternalCollaborationReply Internal Collaboration Reply No Reply from an internal resource
415 117 Normal Normal No StopProcessing Reason Normal
416 117 AutoResponded Auto Responded No StopProcessing Reason Auto Responded
417 117 Terminated Terminated No StopProcessing Reason Terminated
418 117 Sent Sent No StopProcessing Reason Sent
419 117 Forwarded Forwarded No StopProcessing Reason Forwarded
420 117 Re-directed Re-directed No StopProcessing Reason Re-directed
421 118 English English No Language English
422 121 Priority Priority No Interaction Attributes Priority
423 121 Category Category No Interaction Attributes Category
424 121 ServiceType Service Type No Interaction Attributes Service Type
425 121 MediaType Media Type No Interaction Attributes Media Type
426 121 InteractionType Interaction Type No Interaction Attributes Interaction Type
427 121 InteractionSubtype Interaction Subtype No Interaction Attributes Interaction Subtype
428 121 Language Language No Interaction Attributes Language
429 121 StopProcessing-Reason StopProcessing Reason No Interaction Attributes StopProcessing Reason
430 121 DispositionCode Disposition Code No Interaction Attributes Disposition Code
431 121 ReasonCode Reason Code No Interaction Attributes Reason Code
432 122 FirstName First Name No Contact Attributes First Name
433 122 LastName Last Name No Contact Attributes Last Name
434 122 Title Title No Contact Attributes Title
435 122 EmailAddress Email Address No Contact Attributes E-mail Address
436 122 PhoneNumber Phone Number No Contact Attributes Phone Number
437 122 AccountNumber Account Number No Contact Attributes Account Number
438 122 ContactId Contact ID No Contact Attributes Contact ID
439 122 CustomerSegment Customer Segment No Contact Attributes Customer Segment
440 122 PIN PIN No Contact Attributes PIN

On GUI representation the name ___EnumeratorValue___ was replaced on ___Attribute Value___

See also:

CfgDeltaEnumeratorValue

CfgEnumerator


Field Summary
static CfgObjectType OBJECT_TYPE
           
 
Constructor Summary
CfgEnumeratorValue(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgEnumeratorValue(IConfService confService, ConfObject objData, boolean isSaved, java.lang.Object[] additionalParameters)
          This constructor is intended for creation of objects from configuration protocol messages.
CfgEnumeratorValue(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 value.
 java.lang.String getDisplayName()
          A pointer to the display name of the enumerator to be shown on GUI and in reports.
 CfgEnumerator getEnumerator()
          A unique identifier of the CfgEnumerator to which this value is allocated.
 java.lang.Integer getEnumeratorDBID()
          Retrieves the dbid of the object that is being linked to by the Enumerator property.
 CfgFlag getIsDefault()
          An indicator whether the value is default.
 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 value is allocated.
 java.lang.Integer getTenantDBID()
          Retrieves the dbid of the object that is being linked to by the Tenant property.
 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 value.
 void setDisplayName(java.lang.String value)
          A pointer to the display name of the enumerator to be shown on GUI and in reports.
 void setEnumerator(CfgEnumerator value)
          A unique identifier of the CfgEnumerator to which this value is allocated.
 void setEnumeratorDBID(int dbid)
          A unique identifier of the CfgEnumerator to which this value is allocated.
 void setIsDefault(CfgFlag value)
          An indicator whether the value is default.
 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 value is allocated.
 void setTenantDBID(int dbid)
          A unique identifier of the CfgTenant to which this enumerator value is allocated.
 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

CfgEnumeratorValue

public CfgEnumeratorValue(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

CfgEnumeratorValue

public CfgEnumeratorValue(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

CfgEnumeratorValue

public CfgEnumeratorValue(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()

getEnumerator

public final CfgEnumerator getEnumerator()
A unique identifier of the CfgEnumerator to which this value is allocated. Mandatory. Once specified, cannot be changed.

Returns:
instance of referred object or null

setEnumerator

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

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

setEnumeratorDBID

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

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

getEnumeratorDBID

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

Returns:
DBID identifier of referred object or null

getTenant

public final CfgTenant getTenant()
A unique identifier of the CfgTenant to which this enumerator value 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 value 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 value 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 enumerator object. 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 enumerator object. 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 value.

Returns:
property value or null

setDescription

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

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

getIsDefault

public final CfgFlag getIsDefault()
An indicator whether the value is default. See CfgFlag

Returns:
property value or null

setIsDefault

public final void setIsDefault(CfgFlag value)
An indicator whether the value is default. See CfgFlag

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

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()

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.