Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgField

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

public class CfgField
extends CfgObject

Fields are single pieces of data within more complex data structures (for example, database records).

Use Fields to define characteristics of the data in Formats. (Refer to the Outbound Contact documentation set for more information.)

A field cannot be deleted as long as it is associated with at least one format (see CfgFormat ).

Uniqueness of object is defined by combination of name and fieldType properties.

The table below lists the outbound mandatory fields and their default settings. Fields should be created as default objects in Configuration Server under the Environment folder.

Outbound Mandatory Fields & Settings
fieldType name description isPrimary Key isUnique isNullable default Value type
CFGFTRecordID record_id Unique record identifier No Yes No No INT
CFGFTPhone contact_info Contact Info No No No No VARCHAR (128)
CFGFTPhoneType contact_info_type Contact Info Type No No No 1= GctiCtTyHomePhone from GctiContactType of Gcti.h INT
CFGFTRecordType record_type Record type No No No 2= GctiRecTyGeneral from GctiRecordType of Gcti.h INT
CFGFTRecordStatus record_status Record status No No No 1= GctiRecStReady from GctiRecordStatus of Gcti.h INT
CFGFTDialResult call_result Dial result No No Yes 28 = GctiCSUnknown from GctiCallState of Gcti.h INT
CFGFTNumberOfAttempts attempt Number of attempts has been made, excluding re-dials in case of errors No No No 0 INT
CFGFTScheduledTime dial_sched_time Time, when scheduled call must be done, seconds since midnight of 01/01/1970 No No Yes No INT
CFGFTCallTime call_time Time when last call or dial attempt has been done, seconds since midnight of 01/01/1970 No No Yes No INT
CFGFTFrom daily_from Earliest time to perform the call. Seconds from midnight. No No No 28800 = 8AM INT
CFGFTUntil daily_till Latest time to perform the call. Seconds from midnight No No No 64800 = 6PM INT
CFGFTTimeZone tz_dbid Time zone. DBID from Configuration Data Base. No No No 122= ___PST___ DBID INT
CFGFTCampaignID campaign_id DBID of the campaign with respect to the last dial attempt has been made. No No Yes No INT
CFGFTAgentID agent_id Agent login identifier No No Yes No VARCHAR (32)
CFGFTChainID chain_id Unique identifier of chain Yes No No No INT
CFGFTNumberInChain chain_n Unique identifier of record within chain Yes No No No INT
CFGFTGroupDBID group_id AgentGroup or PlaceGroup unique identifier (DBID) No No Yes No INT
CFGFTAppDBID app_id Application unique identifier(DBID) No No Yes No INT
CFGFTTreatments treatments Treatments History No No Yes No VARCHAR(255)
CFGFTMediaRefference media_ref Reference to media body to be sent in case of treatment No No Yes No INT
CFGFTEmailSubject email_subject Email Subject No No Yes No VARCHAR(255)
CFGFTEmailTemplateID email_template_id Email Template ID No No Yes No INT
CFGFTSwitchID switch_id Switch ID No No Yes No INT



See also:

CfgDeltaField

CfgFormat


Field Summary
static CfgObjectType OBJECT_TYPE
           
 
Constructor Summary
CfgField(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgField(IConfService confService, ConfObject objData, boolean isSaved, java.lang.Object[] additionalParameters)
          This constructor is intended for creation of objects from configuration protocol messages.
CfgField(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 getDefaultValue()
          A pointer to the default value of field.
 java.lang.String getDescription()
          A pointer to the description of field.
 CfgFieldType getFieldType()
          A field type.
 CfgFlag getIsNullable()
          A flag which determines whether or not a field can allow null values ( NULLs ) for the data in that field.
 CfgFlag getIsPrimaryKey()
          A flag which determines whether or not a field is used as primary key.
 CfgFlag getIsUnique()
          A flag which determines whether or not a field is used as unique.
 java.lang.Integer getLength()
          A length of field in data base.
 java.lang.String getName()
          A field name in data base.
 CfgObjectState getState()
          Current object state.
 CfgTenant getTenant()
          A unique identifier of the CfgTenant that this field belongs to.
 java.lang.Integer getTenantDBID()
          Retrieves the dbid of the object that is being linked to by the Tenant property.
 CfgDataType getType()
          A data type of field in data base.
 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 setDefaultValue(java.lang.String value)
          A pointer to the default value of field.
 void setDescription(java.lang.String value)
          A pointer to the description of field.
 void setFieldType(CfgFieldType value)
          A field type.
 void setIsNullable(CfgFlag value)
          A flag which determines whether or not a field can allow null values ( NULLs ) for the data in that field.
 void setIsPrimaryKey(CfgFlag value)
          A flag which determines whether or not a field is used as primary key.
 void setIsUnique(CfgFlag value)
          A flag which determines whether or not a field is used as unique.
 void setLength(java.lang.Integer value)
          A length of field in data base.
 void setName(java.lang.String value)
          A field name in data base.
 void setState(CfgObjectState value)
          Current object state.
 void setTenant(CfgTenant value)
          A unique identifier of the CfgTenant that this field belongs to.
 void setTenantDBID(int dbid)
          A unique identifier of the CfgTenant that this field belongs to.
 void setType(CfgDataType value)
          A data type of field in data base.
 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

CfgField

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

CfgField

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

CfgField

public CfgField(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 that this field 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 CfgTenant that this field 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 CfgTenant that this field 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 field name in data base. Due to restrictions of database engine the recommended length for property name is 1-12 characters. Mandatory, once specified cannot be changed.

Returns:
property value or null

setName

public final void setName(java.lang.String value)
A field name in data base. Due to restrictions of database engine the recommended length for property name is 1-12 characters. Mandatory, once specified cannot be changed.

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

getType

public final CfgDataType getType()
A data type of field in data base. Mandatory, once specified cannot be changed. See CfgDataType

Returns:
property value or null

setType

public final void setType(CfgDataType value)
A data type of field in data base. Mandatory, once specified cannot be changed. See CfgDataType

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

getDescription

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

Returns:
property value or null

setDescription

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

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

getLength

public final java.lang.Integer getLength()
A length of field in data base. Optional, once specified cannot be changed.

Returns:
property value or null

setLength

public final void setLength(java.lang.Integer value)
A length of field in data base. Optional, once specified cannot be changed.

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

getFieldType

public final CfgFieldType getFieldType()
A field type. Refer to CfgFieldType of User Defined Variable types. Mandatory, once specified cannot be changed.

Returns:
property value or null

setFieldType

public final void setFieldType(CfgFieldType value)
A field type. Refer to CfgFieldType of User Defined Variable types. Mandatory, once specified cannot be changed.

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

getDefaultValue

public final java.lang.String getDefaultValue()
A pointer to the default value of field. Specify what value to insert when a user does not enter a value. Optional.

Returns:
property value or null

setDefaultValue

public final void setDefaultValue(java.lang.String value)
A pointer to the default value of field. Specify what value to insert when a user does not enter a value. Optional.

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

getIsPrimaryKey

public final CfgFlag getIsPrimaryKey()
A flag which determines whether or not a field is used as primary key. Once specified cannot be changed. See CfgFlag

Returns:
property value or null

setIsPrimaryKey

public final void setIsPrimaryKey(CfgFlag value)
A flag which determines whether or not a field is used as primary key. Once specified cannot be changed. See CfgFlag

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

getIsUnique

public final CfgFlag getIsUnique()
A flag which determines whether or not a field is used as unique. Once specified cannot be changed. See CfgFlag

Returns:
property value or null

setIsUnique

public final void setIsUnique(CfgFlag value)
A flag which determines whether or not a field is used as unique. Once specified cannot be changed. See CfgFlag

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

getIsNullable

public final CfgFlag getIsNullable()
A flag which determines whether or not a field can allow null values ( NULLs ) for the data in that field. Once specified cannot be changed. See CfgFlag

Returns:
property value or null

setIsNullable

public final void setIsNullable(CfgFlag value)
A flag which determines whether or not a field can allow null values ( NULLs ) for the data in that field. Once specified cannot be changed. See CfgFlag

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

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.