Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgDeltaFolder

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

public class CfgDeltaFolder
extends CfgDelta

The changes to make to a CfgFolder object.


Constructor Summary
CfgDeltaFolder(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgDeltaFolder(IConfService confService, ConfObjectDelta objData)
          This constructor is intended for creation of delta objects from configuration protocol messages.
CfgDeltaFolder(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<CfgObjectID> getAddedObjectIDs()
          Pointer to the list of CfgObjectID objects containing the type and DBID of the objects subordinate to this folder.
 java.util.Collection<CfgObjectResource> getAddedResources()
          A pointer to the list of the objects associated with this Folder (every item of this list is structured as CfgObjectResource ).
 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<CfgObjectResource> getChangedResources()
          A pointer to the list of structures CfgObjectResource type.
 KeyValueCollection getChangedUserProperties()
          A pointer to the list of user-defined properties whose values have been changed.
 java.lang.Integer getCustomType()
          User classificator of the Folder.
 java.lang.Integer getDBID()
          The DBID of the target CfgFolder configuration object.
 java.util.Collection<CfgObjectID> getDeletedObjectIDs()
          A pointer to a list of subordinate objects excluded from the folder's container list.
 java.util.Collection<CfgResourceID> getDeletedResources()
          A pointer to the list of deleted resources (every item of this list is structured as CfgID ).
 KeyValueCollection getDeletedUserProperties()
          A pointer to the list of deleted user-defined properties.
 java.lang.String getDescription()
           
 CfgFolderClass getFolderClass()
          The class of the Folder.Refer to CfgFolderClass enumeration.
 java.lang.String getName()
          A pointer to name of the folder.
 CfgOwnerID getOwnerID()
          A structure containing the object type and DBID of the folder's owner object.
 CfgParentID getParentID()
          A structure containing object type and DBID of the folder's parent, e.g.
 CfgObjectState getState()
          Current object state.
 CfgObjectType getType()
          Type of the objects this folder may contain.
 CfgFolder retrieveCfgFolder()
          Read base CfgFolder 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

CfgDeltaFolder

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

Parameters:
confService - configuration service instance

CfgDeltaFolder

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

CfgDeltaFolder

public CfgDeltaFolder(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 CfgFolder configuration object.

Returns:
target object DBID

retrieveCfgFolder

public final CfgFolder retrieveCfgFolder()
                                  throws ConfigException
Read base CfgFolder configuration object caused this event.

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

getName

public final java.lang.String getName()
A pointer to name of the folder. Mandatory. Must be unique within the parent object.

Returns:
property value or null

getType

public final CfgObjectType getType()
Type of the objects this folder may contain. A folder may contain either objects of this type or subfolders with the same value of type property. See the CfgObjectType enumeration.

Returns:
property value or null

getOwnerID

public final CfgOwnerID getOwnerID()
A structure containing the object type and DBID of the folder's owner object. Unlike parentID, this field defines the folder's logical affiliation rather than its hierarchical affiliation. An owner may be an object of the following types: CfgTenant , CfgSwitch , CfgIVR , or CfgEnumerator . See CfgID .

Returns:
property value 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

getAddedObjectIDs

public final java.util.Collection<CfgObjectID> getAddedObjectIDs()
Pointer to the list of CfgObjectID objects containing the type and DBID of the objects subordinate to this folder. Only objects of the type equal to the folder's type property or subfolders of this type may be contained in this list.

Returns:
list of structures or null

getParentID

public final CfgParentID getParentID()
A structure containing object type and DBID of the folder's parent, e.g. object which stands higher in the hierarchy. This may be another folder, if this folder is a subfolder, or this field may coincide with ownerID field if this folder is a topmost (default) one. A parent may an object of the following types: CfgFolder , CfgTenant , CfgSwitch , CfgIVR , or CfgEnumerator . See CfgID .

Returns:
property value or null

getDescription

public final java.lang.String getDescription()

getFolderClass

public final CfgFolderClass getFolderClass()
The class of the Folder.Refer to CfgFolderClass enumeration.

Returns:
property value or null

getCustomType

public final java.lang.Integer getCustomType()
User classificator of the Folder. Optional.

Returns:
property value or null

getAddedResources

public final java.util.Collection<CfgObjectResource> getAddedResources()
A pointer to the list of the objects associated with this Folder (every item of this list is structured as CfgObjectResource ). When used as an entry in CfgDeltaFolder , it is a pointer to a list of resources added to the existing list. Only objects of type CfgFolder , CfgObjectiveTable , CfgGVPIVRProfile , CfgGVPCustomer , CfgTimeZone , CfgHost can be associated with Folder object through resources

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

getDeletedObjectIDs

public final java.util.Collection<CfgObjectID> getDeletedObjectIDs()
A pointer to a list of subordinate objects excluded from the folder's container list. Contains structures of type CfgID .

Returns:
list of structures or null

getDeletedResources

public final java.util.Collection<CfgResourceID> getDeletedResources()
A pointer to the list of deleted resources (every item of this list is structured as CfgID ).

Returns:
list of structures or null

getChangedResources

public final java.util.Collection<CfgObjectResource> getChangedResources()
A pointer to the list of structures CfgObjectResource type. Each structure contains information about the resource parameters that have been changed.

Returns:
list of structures 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.