Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgDeltaHost

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

public class CfgDeltaHost
extends CfgDelta

The changes to make to a CfgHost object.


Constructor Summary
CfgDeltaHost(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgDeltaHost(IConfService confService, ConfObjectDelta objData)
          This constructor is intended for creation of delta objects from configuration protocol messages.
CfgDeltaHost(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<CfgObjectResource> getAddedResources()
          A pointer to the list of the objects associated with this Host (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.
 CfgAddress getAddress()
          Not in use.
 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.String getComment()
          Not in use.
 CfgPerson getContactPerson()
          Not in use.
 java.lang.Integer getContactPersonDBID()
          Retrieves the dbid of the object that is being linked to by the ContactPerson property.
 java.lang.Integer getDBID()
          The DBID of the target CfgHost configuration object.
 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 getHWID()
          Not in use.
 java.lang.String getIPaddress()
          A pointer to the IP address of the host.
 java.lang.String getLCAPort()
          A port on which the Local Control Agent for this host is supposed to be running.
 java.lang.String getName()
          A pointer to name of the host.
 CfgOS getOSinfo()
          A pointer to the structure containing information about the operating system of this host.
 CfgApplication getSCS()
          A unique identifier of an CfgApplication of CFGSCS type which is supposed to monitor/control this host.
 java.lang.Integer getSCSDBID()
          Retrieves the dbid of the object that is being linked to by the SCS property.
 CfgObjectState getState()
          Current object state.
 CfgHostType getType()
          Type of the host.
 CfgHost retrieveCfgHost()
          Read base CfgHost 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

CfgDeltaHost

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

Parameters:
confService - configuration service instance

CfgDeltaHost

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

CfgDeltaHost

public CfgDeltaHost(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 CfgHost configuration object.

Returns:
target object DBID

retrieveCfgHost

public final CfgHost retrieveCfgHost()
                              throws ConfigException
Read base CfgHost 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 host. Mandatory. Must be unique within the Configuration Database. Cannot be changed as long as at least one server is assigned to this host.

Returns:
property value or null

getHWID

public final java.lang.String getHWID()
Not in use.

Returns:
property value or null

getIPaddress

public final java.lang.String getIPaddress()
A pointer to the IP address of the host. Optional. Must be unique within the Configuration Database. Max length 64 symbols.

Returns:
property value or null

getOSinfo

public final CfgOS getOSinfo()
A pointer to the structure containing information about the operating system of this host. Once specified, cannot be set to NULL. See structure CfgOS .

Returns:
property value or null

getType

public final CfgHostType getType()
Type of the host. Mandatory. Once specified, cannot be changed. See type CfgHostType .

Returns:
property value or null

getAddress

public final CfgAddress getAddress()
Not in use.

Returns:
property value or null

getContactPerson

public final CfgPerson getContactPerson()
Not in use.

Returns:
instance of referred object or null

getContactPersonDBID

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

Returns:
DBID identifier of referred object or null

getComment

public final java.lang.String getComment()
Not in use.

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

getLCAPort

public final java.lang.String getLCAPort()
A port on which the Local Control Agent for this host is supposed to be running. Mandatory. Default value for migration from 5.1.xxx to 5.9.xxx is 4999, for newly created hosts the value must be specified. Allowed value is any positive whole number within 0-9999 range.

Returns:
property value or null

getSCS

public final CfgApplication getSCS()
A unique identifier of an CfgApplication of CFGSCS type which is supposed to monitor/control this host. This property is valid only if Distributed SCS functionality is enabled.

Returns:
instance of referred object or null

getSCSDBID

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

Returns:
DBID identifier of referred object or null

getAddedResources

public final java.util.Collection<CfgObjectResource> getAddedResources()
A pointer to the list of the objects associated with this Host (every item of this list is structured as CfgObjectResource ). When used as an entry in CfgDeltaHost , it is a pointer to a list of resources added to the existing list. Only objects of type CfgEnumeratorType , CfgScript and CfgApplication can be associated with Host 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

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.