|
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.CfgField
public class CfgField
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.
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 |
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 |
---|
public static final CfgObjectType OBJECT_TYPE
Constructor Detail |
---|
public CfgField(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 CfgField(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 CfgField(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()
CfgTenant
that this field belongs to. Mandatory. Once specified, cannot be
changed.
public final void setTenant(CfgTenant value)
CfgTenant
that this field belongs to. Mandatory. Once specified, cannot be
changed.
value
- new property valuegetTenant()
public final void setTenantDBID(int dbid)
CfgTenant
that this field 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 CfgDataType getType()
CfgDataType
public final void setType(CfgDataType value)
CfgDataType
value
- new property valuegetType()
public final java.lang.String getDescription()
public final void setDescription(java.lang.String value)
value
- new property valuegetDescription()
public final java.lang.Integer getLength()
public final void setLength(java.lang.Integer value)
value
- new property valuegetLength()
public final CfgFieldType getFieldType()
CfgFieldType
of
User Defined Variable types. Mandatory, once specified cannot be
changed.
public final void setFieldType(CfgFieldType value)
CfgFieldType
of
User Defined Variable types. Mandatory, once specified cannot be
changed.
value
- new property valuegetFieldType()
public final java.lang.String getDefaultValue()
public final void setDefaultValue(java.lang.String value)
value
- new property valuegetDefaultValue()
public final CfgFlag getIsPrimaryKey()
CfgFlag
public final void setIsPrimaryKey(CfgFlag value)
CfgFlag
value
- new property valuegetIsPrimaryKey()
public final CfgFlag getIsUnique()
CfgFlag
public final void setIsUnique(CfgFlag value)
CfgFlag
value
- new property valuegetIsUnique()
public final CfgFlag getIsNullable()
CfgFlag
public final void setIsNullable(CfgFlag value)
CfgFlag
value
- new property valuegetIsNullable()
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 |