Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgActionCode

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

public class CfgActionCode
extends CfgObject

Action coding enables agents to report the business results of customer interactions, as well as to explain the reasons for certain operations.

After you select an appropriate code from a menu of predefined Action Codes, the code is passed along with its related request. The code then returns with the event, which indicates that the request has been successfully processed. Eventually, the code is stored in the reporting database.

You can supplement each Action Code with a number of Subcodes that more precisely characterize the reasons for a certain action.

See also:

CfgDeltaActionCode


Field Summary
static CfgObjectType OBJECT_TYPE
           
 
Constructor Summary
CfgActionCode(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgActionCode(IConfService confService, ConfObject objData, boolean isSaved, java.lang.Object[] additionalParameters)
          This constructor is intended for creation of objects from configuration protocol messages.
CfgActionCode(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.String getCode()
          A pointer to the index or abbreviation of the action code.
 java.lang.Integer getDBID()
          An identifier of this object in the Configuration Database.
 java.lang.String getName()
          A pointer to the name of the action code.
 CfgObjectState getState()
          Current object state.
 java.util.Collection<CfgSubcode> getSubcodes()
          A pointer to the list of the subcodes defined within the action code (every item of this list is structured as CfgSubcode ).
 CfgTenant getTenant()
          A unique identifier of the Tenant that this action code belongs to.
 java.lang.Integer getTenantDBID()
          Retrieves the dbid of the object that is being linked to by the Tenant property.
 CfgActionCodeType getType()
          Type of the action code.
 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 setCode(java.lang.String value)
          A pointer to the index or abbreviation of the action code.
 void setDBID(java.lang.Integer value)
          An identifier of this object in the Configuration Database.
 void setName(java.lang.String value)
          A pointer to the name of the action code.
 void setState(CfgObjectState value)
          Current object state.
 void setSubcodes(java.util.Collection<CfgSubcode> value)
          A pointer to the list of the subcodes defined within the action code (every item of this list is structured as CfgSubcode ).
 void setTenant(CfgTenant value)
          A unique identifier of the Tenant that this action code belongs to.
 void setTenantDBID(int dbid)
          A unique identifier of the Tenant that this action code belongs to.
 void setType(CfgActionCodeType value)
          Type of the action code.
 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

CfgActionCode

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

CfgActionCode

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

CfgActionCode

public CfgActionCode(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 Tenant that this action code belongs to. 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 Tenant that this action code belongs to. 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 Tenant that this action code belongs to. 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 name of the action code. Mandatory. Must be unique within the action code type specified below for the given tenant.

Returns:
property value or null

setName

public final void setName(java.lang.String value)
A pointer to the name of the action code. Mandatory. Must be unique within the action code type specified below for the given tenant.

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

getType

public final CfgActionCodeType getType()
Type of the action code. See type CfgActionCodeType. Mandatory. Once specified, cannot be changed.

Returns:
property value or null

setType

public final void setType(CfgActionCodeType value)
Type of the action code. See type CfgActionCodeType. Mandatory. Once specified, cannot be changed.

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

getCode

public final java.lang.String getCode()
A pointer to the index or abbreviation of the action code. Mandatory. Must be unique within the action code type specified above for the given tenant.

Returns:
property value or null

setCode

public final void setCode(java.lang.String value)
A pointer to the index or abbreviation of the action code. Mandatory. Must be unique within the action code type specified above for the given tenant.

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

getSubcodes

public final java.util.Collection<CfgSubcode> getSubcodes()
A pointer to the list of the subcodes defined within the action code (every item of this list is structured as CfgSubcode ). When used as an entry in CfgDeltaActionCode (see below), it is a pointer to a list of subcodes added to the existing list.

Returns:
list of structures or null

setSubcodes

public final void setSubcodes(java.util.Collection<CfgSubcode> value)
A pointer to the list of the subcodes defined within the action code (every item of this list is structured as CfgSubcode ). When used as an entry in CfgDeltaActionCode (see below), it is a pointer to a list of subcodes added to the existing list.

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

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

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.