|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.applicationblocks.com.CfgBase
com.genesyslab.platform.applicationblocks.com.CfgObject
com.genesyslab.platform.applicationblocks.com.objects.CfgActionCode
public class CfgActionCode
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.
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 |
---|
public static final CfgObjectType OBJECT_TYPE
Constructor Detail |
---|
public CfgActionCode(IConfService confService, ConfObject objData, boolean isSaved, java.lang.Object[] additionalParameters)
confService
- configuration service instanceobjData
- configuration protocol object data structureisSaved
- indicator of the object saved stateadditionalParameters
- additional parameters from configuration protocol messagepublic CfgActionCode(IConfService confService, org.w3c.dom.Node xmlData, java.lang.Object[] additionalParameters)
confService
- configuration service instancexmlData
- XML object containing object dataadditionalParameters
- additional parameters from configuration protocol messagepublic CfgActionCode(IConfService confService)
confService
- configuration service instanceMethod Detail |
---|
public void save() throws ConfigException
save
in interface ICfgObject
save
in class CfgObject
ConfigException
- in case of protocol level exception, data transformation,
or server side constraintspublic final java.lang.Integer getDBID()
public final void setDBID(java.lang.Integer value)
value
- new property valuegetDBID()
public final CfgTenant getTenant()
Tenant
that this action code belongs to. Mandatory. Once specified,
cannot be changed.
public final void setTenant(CfgTenant value)
Tenant
that this action code belongs to. Mandatory. Once specified,
cannot be changed.
value
- new property valuegetTenant()
public final void setTenantDBID(int dbid)
Tenant
that this action code belongs to. Mandatory. Once specified,
cannot be changed.
dbid
- DBID identifier of referred objectgetTenant()
public final java.lang.Integer getTenantDBID()
public final java.lang.String getName()
public final void setName(java.lang.String value)
value
- new property valuegetName()
public final CfgActionCodeType getType()
CfgActionCodeType
. Mandatory.
Once specified, cannot be changed.
public final void setType(CfgActionCodeType value)
CfgActionCodeType
. Mandatory.
Once specified, cannot be changed.
value
- new property valuegetType()
public final java.lang.String getCode()
public final void setCode(java.lang.String value)
value
- new property valuegetCode()
public final java.util.Collection<CfgSubcode> getSubcodes()
CfgSubcode
). When used as an entry in CfgDeltaActionCode
(see below), it is a pointer to a list of subcodes added to the existing list.
public final void setSubcodes(java.util.Collection<CfgSubcode> value)
CfgSubcode
). When used as an entry in CfgDeltaActionCode
(see below), it is a pointer to a list of subcodes added to the existing list.
value
- new property valuegetSubcodes()
public final CfgObjectState getState()
CfgObjectState
public final void setState(CfgObjectState value)
CfgObjectState
value
- new property valuegetState()
public final KeyValueCollection getUserProperties()
public final void setUserProperties(KeyValueCollection value)
value
- new property valuegetUserProperties()
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |