Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgTransaction

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

public class CfgTransaction
extends CfgObject

Transactions define how CTI applications calculate customer-defined statistics.

See also:

CfgDeltaTransaction


Field Summary
static CfgObjectType OBJECT_TYPE
           
 
Constructor Summary
CfgTransaction(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgTransaction(IConfService confService, ConfObject objData, boolean isSaved, java.lang.Object[] additionalParameters)
          This constructor is intended for creation of objects from configuration protocol messages.
CfgTransaction(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 getAlias()
          An alternative name for this transaction.
 java.lang.Integer getDBID()
          An identifier of this object in the Configuration Database.
 java.lang.String getDescription()
          A pointer to the text description of the transaction.
 java.lang.String getName()
          A pointer to the name of the transaction.
 java.lang.Integer getRecordPeriod()
          Period in minutes that shows how often the current value of the transaction is to be reported or recorded in a data storage.
 CfgObjectState getState()
          Current object state.
 CfgTenant getTenant()
          A unique identifier of the Tenant that this transaction belongs to.
 java.lang.Integer getTenantDBID()
          Retrieves the dbid of the object that is being linked to by the Tenant property.
 CfgTransactionType getType()
          Type of the transaction.
 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 setAlias(java.lang.String value)
          An alternative name for this transaction.
 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 text description of the transaction.
 void setName(java.lang.String value)
          A pointer to the name of the transaction.
 void setRecordPeriod(java.lang.Integer value)
          Period in minutes that shows how often the current value of the transaction is to be reported or recorded in a data storage.
 void setState(CfgObjectState value)
          Current object state.
 void setTenant(CfgTenant value)
          A unique identifier of the Tenant that this transaction belongs to.
 void setTenantDBID(int dbid)
          A unique identifier of the Tenant that this transaction belongs to.
 void setType(CfgTransactionType value)
          Type of the transaction.
 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

CfgTransaction

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

CfgTransaction

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

CfgTransaction

public CfgTransaction(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 transaction 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 transaction 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 transaction 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 transaction. Mandatory. Must be unique within the transaction 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 transaction. Mandatory. Must be unique within the transaction type specified below for the given tenant.

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

getType

public final CfgTransactionType getType()
Type of the transaction. See type CfgTansactionType. Mandatory. Once specified, cannot be changed. Shall be set to CFGTransaction for PEG counts.

Returns:
property value or null

setType

public final void setType(CfgTransactionType value)
Type of the transaction. See type CfgTansactionType. Mandatory. Once specified, cannot be changed. Shall be set to CFGTransaction for PEG counts.

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

getRecordPeriod

public final java.lang.Integer getRecordPeriod()
Period in minutes that shows how often the current value of the transaction is to be reported or recorded in a data storage.

Returns:
property value or null

setRecordPeriod

public final void setRecordPeriod(java.lang.Integer value)
Period in minutes that shows how often the current value of the transaction is to be reported or recorded in a data storage.

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

getAlias

public final java.lang.String getAlias()
An alternative name for this transaction. If specified, must be unique within the object type specified above for the given tenant .

Returns:
property value or null

setAlias

public final void setAlias(java.lang.String value)
An alternative name for this transaction. If specified, must be unique within the object type specified above for the given tenant .

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

getDescription

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

Returns:
property value or null

setDescription

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

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

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.