Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgDeltaObjectiveTable

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.CfgDelta
              extended by com.genesyslab.platform.applicationblocks.com.objects.CfgDeltaObjectiveTable
All Implemented Interfaces:
ICfgBase, ICfgDelta, ICfgObject, java.lang.Cloneable

public class CfgDeltaObjectiveTable
extends CfgDelta

The changes to make to a CfgObjectiveTable object.


Constructor Summary
CfgDeltaObjectiveTable(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgDeltaObjectiveTable(IConfService confService, ConfObjectDelta objData)
          This constructor is intended for creation of delta objects from configuration protocol messages.
CfgDeltaObjectiveTable(IConfService confService, org.w3c.dom.Node xmlData)
          This constructor is intended for creation of delta objects from configuration protocol messages.
 
Method Summary
 java.util.Collection<CfgObjectiveTableRecord> getAddedObjectiveRecords()
          A pointer to the list of identifiers of objective records comprising this objective table.
 KeyValueCollection getAddedUserProperties()
          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.
 java.util.Collection<CfgObjectiveTableRecord> getChangedObjectiveRecords()
          A pointer to a list of objective records changed within the objective table.
 KeyValueCollection getChangedUserProperties()
          A pointer to the list of user-defined properties whose values have been changed.
 java.lang.Integer getDBID()
          The DBID of the target CfgObjectiveTable configuration object.
 java.util.Collection<CfgObjectiveTableRecord> getDeletedObjectiveRecords()
          A pointer to a list of objective records excluded from the objective table.
 KeyValueCollection getDeletedUserProperties()
          A pointer to the list of deleted user-defined properties.
 java.lang.String getDescription()
          A pointer to the description of the objective table.
 java.lang.String getName()
          A pointer to the name of the objective table.
 java.lang.Integer getPrepaidCost()
          A flat rate for the cost per call.
 CfgObjectState getState()
          Current object state.
 CfgTenant getTenant()
          A unique identifier of the CfgTenant to which this objective table is allocated.
 java.lang.Integer getTenantDBID()
          Retrieves the dbid of the object that is being linked to by the Tenant property.
 java.util.Calendar getTimeEnd()
          The date on which to end the Volume Rate Contract.
 java.util.Calendar getTimeStart()
          The date on which to start the Volume Rate Contract.
 CfgTimeZone getTimeZone()
          A CfgTimeZone associated with this Cost Contract
 java.lang.Integer getTimeZoneDBID()
          Retrieves the dbid of the object that is being linked to by the TimeZone property.
 CfgObjectiveTableType getType()
          Objective Table type.
 CfgObjectiveTable retrieveCfgObjectiveTable()
          Read base CfgObjectiveTable configuration object caused this event.
 
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgDelta
ensureDataBackup, retrieveObject, save, toStringProperties, update
 
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgObject
clone, delete, doSetFolderId, getFolderId, getObjectDbid, getObjectPath, getObjectType, refresh, reloadObjectWithNewData, reloadObjectWithNewData, removeAccount, resetDataBackup, retrieveAccountPermissions, retrieveACL, retrievePermissions, setAccountPermissions, setAccountPermissions, setFolderId, 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, 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
 

Constructor Detail

CfgDeltaObjectiveTable

public CfgDeltaObjectiveTable(IConfService confService)
This constructor is intended for creation of detached objects.

Parameters:
confService - configuration service instance

CfgDeltaObjectiveTable

public CfgDeltaObjectiveTable(IConfService confService,
                              ConfObjectDelta objData)
This constructor is intended for creation of delta objects from configuration protocol messages. It is internally used by COM AB for delta objects deserialization.

Parameters:
confService - configuration service instance
objData - configuration protocol object delta data

CfgDeltaObjectiveTable

public CfgDeltaObjectiveTable(IConfService confService,
                              org.w3c.dom.Node xmlData)
This constructor is intended for creation of delta objects from configuration protocol messages. It is internally used by COM AB for delta objects deserialization.

Parameters:
confService - configuration service instance
xmlData - XML object containing object delta data
Method Detail

getDBID

public final java.lang.Integer getDBID()
The DBID of the target CfgObjectiveTable configuration object.

Returns:
target object DBID

retrieveCfgObjectiveTable

public final CfgObjectiveTable retrieveCfgObjectiveTable()
                                                  throws ConfigException
Read base CfgObjectiveTable configuration object caused this event.

Returns:
configuration object read
Throws:
ConfigException - in case of problem while object reading

getTenant

public final CfgTenant getTenant()
A unique identifier of the CfgTenant to which this objective table is allocated. Mandatory. Once specified, cannot be changed.

Returns:
instance of referred object or null

getTenantDBID

public final java.lang.Integer getTenantDBID()
Retrieves the dbid of the object that is being linked to by the Tenant property. Configuration server provides it only if the property value has been changed.

Returns:
DBID identifier of referred object or null

getName

public final java.lang.String getName()
A pointer to the name of the objective table. Mandatory. Must be unique within the tenant environment.

Returns:
property value or null

getDescription

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

Returns:
property value or null

getAddedObjectiveRecords

public final java.util.Collection<CfgObjectiveTableRecord> getAddedObjectiveRecords()
A pointer to the list of identifiers of objective records comprising this objective table.

Returns:
list of structures or null

getState

public final CfgObjectState getState()
Current object state. Mandatory. Refer to CfgObjectState

Returns:
property value or null

getAddedUserProperties

public final KeyValueCollection getAddedUserProperties()
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

getPrepaidCost

public final java.lang.Integer getPrepaidCost()
A flat rate for the cost per call.

Returns:
property value or null

getTimeZone

public final CfgTimeZone getTimeZone()
A CfgTimeZone associated with this Cost Contract

Returns:
instance of referred object or null

getTimeZoneDBID

public final java.lang.Integer getTimeZoneDBID()
Retrieves the dbid of the object that is being linked to by the TimeZone property. Configuration server provides it only if the property value has been changed.

Returns:
DBID identifier of referred object or null

getTimeStart

public final java.util.Calendar getTimeStart()
The date on which to start the Volume Rate Contract.

Returns:
property value or null

getTimeEnd

public final java.util.Calendar getTimeEnd()
The date on which to end the Volume Rate Contract.

Returns:
property value or null

getType

public final CfgObjectiveTableType getType()
Objective Table type. Refer to CfgObjectiveTableType

Returns:
property value or null

getDeletedObjectiveRecords

public final java.util.Collection<CfgObjectiveTableRecord> getDeletedObjectiveRecords()
A pointer to a list of objective records excluded from the objective table.

Returns:
list of structures or null

getChangedObjectiveRecords

public final java.util.Collection<CfgObjectiveTableRecord> getChangedObjectiveRecords()
A pointer to a list of objective records changed within the objective table.

Returns:
list of structures or null

getDeletedUserProperties

public final KeyValueCollection getDeletedUserProperties()
A pointer to the list of deleted user-defined properties. Has the same structure as parameter userProperties.

Returns:
property value or null

getChangedUserProperties

public final KeyValueCollection getChangedUserProperties()
A pointer to the list of user-defined properties whose values have been changed. Has the same structure as parameter userProperties

Returns:
property value or null

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.