Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgFormat

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

public class CfgFormat
extends CfgObject

Use Formats to specify Fields that form a data structure (for example, a database table).

One format can be dedicated to several objects of type CfgTableAccess .

A format cannot be deleted as long as it is associated with at least one TableAccess or Filter (see CfgTableAccess and CfgFilter respectively). The list of fields cannot be changed as long as it is associated with at least one TableAccess or Filter (see CfgTableAccess and CfgFilter , respectively)

CfgField must be unique within CfgFormat .

Predefined Formats
Name Tenant[if applicable] Description Fields
Default_Outbound_6 Environment Default format for Outbound Suite (before 7.0 release) CFGFTRecordID
CFGFTPhone
CFGFTRecordType
CFGFTRecordStatus
CFGFTDialResult
CFGFTNumberOfAttempts
CFGFTScheduledTime
CFGFTCallTime
CFGFTFrom
CFGFTUntil
CFGFTTimeZone
CFGFTCompaignID
CFGFTAgentID
CFGFTChainID
CFGFTNumberInChain
CFGFTPhoneType
Default_Outbound_70 Environment Default format for Outbound Suite (starting from 7.0 release) CFGFTRecordID
CFGFTPhone
CFGFTRecordType
CFGFTRecordStatus
CFGFTDialResult
CFGFTNumberOfAttempts
CFGFTScheduledTime
CFGFTCallTime
CFGFTFrom
CFGFTUntil
CFGFTTimeZone
CFGFTCompaignID
CFGFTAgentID
CFGFTChainID
CFGFTNumberInChain
CFGFTPhoneType
CFGFTGroupDBID
CFGFTAppDBID
CFGFTTreatments
CFGFTMediaRefference
CFGFTEmailSubject
CFGFTEmailTemplateID
CFGFTSwitchID
Default_DoNotCall_List Environment Default format for Do Not Call List CFGFTPhone



See also:

CfgDeltaFormat

CfgField

CfgTableAccess


Field Summary
static CfgObjectType OBJECT_TYPE
           
 
Constructor Summary
CfgFormat(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgFormat(IConfService confService, ConfObject objData, boolean isSaved, java.lang.Object[] additionalParameters)
          This constructor is intended for creation of objects from configuration protocol messages.
CfgFormat(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 format.
 java.util.Collection<java.lang.Integer> getFieldDBIDs()
          Retrieves dbids of objects that are being linked to by the Fields property.
 java.util.Collection<CfgField> getFields()
          A pointer to the list of identifiers of CfgField objects that this format consists of.
 java.lang.String getName()
          A pointer to the name of the format.
 CfgObjectState getState()
          Current object state.
 CfgTenant getTenant()
          A unique identifier of the CfgTenant to which this format 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 format.
 void setFieldDBIDs(java.util.Collection<java.lang.Integer> value)
          Sets dbids collection of objects that are being linked to by the Fields property.
 void setFields(java.util.Collection<CfgField> value)
          A pointer to the list of identifiers of CfgField objects that this format consists of.
 void setName(java.lang.String value)
          A pointer to the name of the format.
 void setState(CfgObjectState value)
          Current object state.
 void setTenant(CfgTenant value)
          A unique identifier of the CfgTenant to which this format is allocated.
 void setTenantDBID(int dbid)
          A unique identifier of the CfgTenant to which this format 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

CfgFormat

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

CfgFormat

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

CfgFormat

public CfgFormat(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 to which this format 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 format 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 format 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 name of the format. 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 pointer to the name of the format. 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()

getDescription

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

Returns:
property value or null

setDescription

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

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

getFields

public final java.util.Collection<CfgField> getFields()
A pointer to the list of identifiers of CfgField objects that this format consists of.

Returns:
list of configuration objects or null

setFields

public final void setFields(java.util.Collection<CfgField> value)
A pointer to the list of identifiers of CfgField objects that this format consists of.

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

getFieldDBIDs

public final java.util.Collection<java.lang.Integer> getFieldDBIDs()
Retrieves dbids of objects that are being linked to by the Fields property. It's a snapshot collection containing original values. Modification of this collection instance will not affect actual value of the objects' property.

Returns:
collection of DBID identifiers of referred objects or null

setFieldDBIDs

public final void setFieldDBIDs(java.util.Collection<java.lang.Integer> value)
Sets dbids collection of objects that are being linked to by the Fields property.

Parameters:
value - collection of DBID identifiers of referred objects

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.