Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com
Class CfgBriefInfo

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.CfgBriefInfo
All Implemented Interfaces:
ICfgBase, ICfgBriefInfo, ICfgObject, java.lang.Cloneable
Direct Known Subclasses:
CfgAccessGroupBrief, CfgPersonBrief, CfgTenantBrief

public abstract class CfgBriefInfo
extends CfgObject
implements ICfgBriefInfo

The base class for all Configuration Server brief info structures.


Constructor Summary
protected CfgBriefInfo(IConfService confService, ConfObjectBrief objData, java.lang.Object[] additionalParameters)
          Main constructor designed for usage from generated classes in deserializing constructors.
protected CfgBriefInfo(IConfService confService, org.w3c.dom.Node xmlData, java.lang.Object[] additionalParameters)
          Main constructor designed for usage from generated classes in deserializing constructors.
 
Method Summary
protected  void ensureDataBackup()
          This internal method is designed for "lazy initialization" of DOM data backup.
protected  ICfgObject getParent()
          Brief Info structures do not have "parent" containers.
 ICfgObject retrieveObject()
          Read "full" version of the configuration object from the server.
 void save()
          Synchronizes changes in a class with Configuration Server.
 void update(ICfgDelta deltaObject)
          Updates the current object from the passed delta object.
protected  void updateChildrenSavedState()
           
 
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, getProperty, getProperty, getProperty, getRawObjectData, hashCode, initStruct, isSaved, lockObject, resolveLink, setProperty, toString, toStringProperties, toXml
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.genesyslab.platform.applicationblocks.com.ICfgBriefInfo
getID
 
Methods inherited from interface com.genesyslab.platform.applicationblocks.com.ICfgObject
clone, delete, getObjectDbid, getObjectType, refresh
 
Methods inherited from interface com.genesyslab.platform.applicationblocks.com.ICfgBase
getEndpoint, getProperty, getRawObjectData, setProperty, toXml
 

Constructor Detail

CfgBriefInfo

protected CfgBriefInfo(IConfService confService,
                       ConfObjectBrief objData,
                       java.lang.Object[] additionalParameters)
Main constructor designed for usage from generated classes in deserializing constructors.

Parameters:
confService - configuration service instance
objData - configuration protocol data
parent - configuration object containing this structure

CfgBriefInfo

protected CfgBriefInfo(IConfService confService,
                       org.w3c.dom.Node xmlData,
                       java.lang.Object[] additionalParameters)
Main constructor designed for usage from generated classes in deserializing constructors.

Parameters:
confService - configuration service instance
xmlData - bound data from Configuration SDK message
parent - configuration object containing this structure
Method Detail

ensureDataBackup

protected void ensureDataBackup()
Description copied from class: CfgObject
This internal method is designed for "lazy initialization" of DOM data backup. It is automatically called before any object property change and it has to create backup copy of object DOM data if it has not been created before.

Overrides:
ensureDataBackup in class CfgObject

getParent

protected ICfgObject getParent()
Brief Info structures do not have "parent" containers.

Overrides:
getParent in class CfgBase
Returns:
null

retrieveObject

public final ICfgObject retrieveObject()
                                throws ConfigException
Read "full" version of the configuration object from the server.

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

updateChildrenSavedState

protected void updateChildrenSavedState()
Overrides:
updateChildrenSavedState in class CfgBase

save

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

Specified by:
save in interface ICfgObject
Overrides:
save in class CfgObject
Throws:
ConfigException - exception while requesting configuration information update

update

public void update(ICfgDelta deltaObject)
Description copied from class: CfgObject
Updates the current object from the passed delta object.

Specified by:
update in interface ICfgObject
Overrides:
update in class CfgObject
Parameters:
deltaObject - the delta object received from configuration server

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.