Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com
Interface ICfgObject

All Superinterfaces:
java.lang.Cloneable, ICfgBase
All Known Subinterfaces:
ICfgBriefInfo
All Known Implementing Classes:
CfgAccessGroup, CfgAccessGroupBrief, CfgActionCode, CfgAgentGroup, CfgAgentLogin, CfgAlarmCondition, CfgApplication, CfgAppPrototype, CfgBriefInfo, CfgCallingList, CfgCampaign, CfgCampaignGroup, CfgDelta, CfgDeltaAccessGroup, CfgDeltaActionCode, CfgDeltaAgentGroup, CfgDeltaAgentInfo, CfgDeltaAgentLogin, CfgDeltaAlarmCondition, CfgDeltaApplication, CfgDeltaAppPrototype, CfgDeltaCallingList, CfgDeltaCampaign, CfgDeltaCampaignGroup, CfgDeltaDN, CfgDeltaDNGroup, CfgDeltaEnumerator, CfgDeltaEnumeratorValue, CfgDeltaField, CfgDeltaFilter, CfgDeltaFolder, CfgDeltaFormat, CfgDeltaGroup, CfgDeltaGVPCustomer, CfgDeltaGVPIVRProfile, CfgDeltaGVPReseller, CfgDeltaHost, CfgDeltaIVR, CfgDeltaIVRPort, CfgDeltaObjectiveTable, CfgDeltaPerson, CfgDeltaPersonLastLogin, CfgDeltaPhysicalSwitch, CfgDeltaPlace, CfgDeltaPlaceGroup, CfgDeltaRole, CfgDeltaScheduledTask, CfgDeltaScript, CfgDeltaService, CfgDeltaSkill, CfgDeltaStatDay, CfgDeltaStatTable, CfgDeltaSwitch, CfgDeltaTableAccess, CfgDeltaTenant, CfgDeltaTimeZone, CfgDeltaTransaction, CfgDeltaTreatment, CfgDeltaVoicePrompt, CfgDN, CfgDNGroup, CfgEnumerator, CfgEnumeratorValue, CfgField, CfgFilter, CfgFolder, CfgFormat, CfgGVPCustomer, CfgGVPIVRProfile, CfgGVPReseller, CfgHost, CfgIVR, CfgIVRPort, CfgObject, CfgObjectiveTable, CfgPerson, CfgPersonBrief, CfgPersonLastLogin, CfgPhysicalSwitch, CfgPlace, CfgPlaceGroup, CfgRole, CfgScheduledTask, CfgScript, CfgService, CfgSkill, CfgStatDay, CfgStatTable, CfgSwitch, CfgTableAccess, CfgTenant, CfgTenantBrief, CfgTimeZone, CfgTransaction, CfgTreatment, CfgVoicePrompt

public interface ICfgObject
extends ICfgBase, java.lang.Cloneable

An interface that should be supported by all configuration classes (objects that can be independently retrieved from Config Server).

Author:
Petr Makagon, Vladislav Baranovsky, Alexander Filatov, Anton Brazhnyk, Sergii Volokh

Method Summary
 java.lang.Object clone()
          Creates and returns a copy of this object.
 void delete()
          Deletes the current object from the configuration.
 int getObjectDbid()
          Returns the dbid of the current object, or 0 if object has not been saved.
 CfgObjectType getObjectType()
          Get this configuration object type.
 void refresh()
          Updates the current object with the latest state from the configuration server.
 void save()
          Synchronizes changes in a class with Configuration Server.
 void update(ICfgDelta deltaObject)
          Updates the current object from the passed delta object.
 
Methods inherited from interface com.genesyslab.platform.applicationblocks.com.ICfgBase
getEndpoint, getProperty, getRawObjectData, setProperty, toXml
 

Method Detail

getObjectType

CfgObjectType getObjectType()
Get this configuration object type.

Returns:
Configuration object type

getObjectDbid

int getObjectDbid()
Returns the dbid of the current object, or 0 if object has not been saved.

Returns:
Configuration object dbid

save

void save()
          throws ConfigException
Synchronizes changes in a class with Configuration Server. Internally generates the correct delta object and sends it to Configuration Server.

Throws:
ConfigException - in case of protocol level exception, data transformation, or server side constraints

refresh

void refresh()
             throws ConfigException
Updates the current object with the latest state from the configuration server.

Throws:
ConfigException - in case of protocol level exception or data transformation

delete

void delete()
            throws ConfigException
Deletes the current object from the configuration.

Throws:
ConfigException - in case of protocol level exception or server side constraints

update

void update(ICfgDelta deltaObject)
Updates the current object from the passed delta object.

Parameters:
deltaObject - the delta object representing the changes to be made

clone

java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Creates and returns a copy of this object.

Returns:
a clone of this instance.
Throws:
java.lang.CloneNotSupportedException - subclasses that override the clone method can throw this exception to indicate that an instance cannot be cloned.
See Also:
Cloneable

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.