Platform SDK Java 8.5 API Reference

com.genesyslab.platform.apptemplate.configuration
Class GApplicationConfiguration.GHost

java.lang.Object
  extended by com.genesyslab.platform.apptemplate.configuration.GApplicationConfiguration.GHost
All Implemented Interfaces:
IGApplicationConfiguration.IGHost, java.io.Serializable, java.lang.Cloneable
Direct Known Subclasses:
GCOMApplicationConfiguration.GCOMHost
Enclosing class:
GApplicationConfiguration

public static class GApplicationConfiguration.GHost
extends java.lang.Object
implements IGApplicationConfiguration.IGHost, java.lang.Cloneable, java.io.Serializable

Structure describing host where server is configured to run.
It reflects detached information from COM AB CfgHost.

See Also:
CfgHost, Serialized Form

Constructor Summary
GApplicationConfiguration.GHost()
          Default empty constructor.
GApplicationConfiguration.GHost(IGApplicationConfiguration.IGHost conf)
          Coping constructor.
Note: it does not clone referred structure UserProperties.
 
Method Summary
 GApplicationConfiguration.GHost clone()
           
protected  java.lang.String contentToString()
          This method is used from toString() to build string representation of the internal content (configuration properties names and values).
 java.lang.Integer getDbid()
          Returns the host DBID.
 java.lang.String getIPAddress()
          Returns the host TCP/IP address.
 java.lang.String getLCAPort()
          Returns port number on which the Local Control Agent for this host is supposed to be running.
 java.lang.String getName()
          Returns the host name.
 CfgObjectState getObjectState()
          Returns actual object state in the Genesys Configuration Database.
 KeyValueCollection getUserProperties()
          Returns pointer to the list of user-defined properties.
It represents the "Annex" tab of the host object in CME.
 void setDbid(java.lang.Integer dbid)
          Sets the host DBID.
 void setIPAddress(java.lang.String ipaddress)
          Sets the host TCP/IP address.
 void setLCAPort(java.lang.String lcaport)
          Sets port number on which the Local Control Agent for this host is supposed to be running.
 void setName(java.lang.String name)
          Sets the host name.
 void setObjectState(CfgObjectState state)
          Sets actual object state in the Genesys Configuration Database.
 void setUserProperties(KeyValueCollection userProperties)
          Sets pointer to the list of user-defined properties.
It represents the "Annex" tab of the host object in CME.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

GApplicationConfiguration.GHost

public GApplicationConfiguration.GHost()
Default empty constructor. Creates uninitialized configuration object.


GApplicationConfiguration.GHost

public GApplicationConfiguration.GHost(IGApplicationConfiguration.IGHost conf)
Coping constructor.
Note: it does not clone referred structure UserProperties.

Parameters:
conf - original configuration
Method Detail

getName

public java.lang.String getName()
Returns the host name.

Specified by:
getName in interface IGApplicationConfiguration.IGHost
Returns:
host name
See Also:
CfgHost.getName()

getDbid

public java.lang.Integer getDbid()
Returns the host DBID.

Specified by:
getDbid in interface IGApplicationConfiguration.IGHost
Returns:
the host object DBID
See Also:
CfgHost.getDBID()

getIPAddress

public java.lang.String getIPAddress()
Returns the host TCP/IP address.

Specified by:
getIPAddress in interface IGApplicationConfiguration.IGHost
Returns:
the host TCP/IP address
See Also:
CfgHost.getIPaddress()

getLCAPort

public java.lang.String getLCAPort()
Returns port number on which the Local Control Agent for this host is supposed to be running.

Specified by:
getLCAPort in interface IGApplicationConfiguration.IGHost
Returns:
the LCA port number
See Also:
CfgHost.getLCAPort()

getObjectState

public CfgObjectState getObjectState()
Returns actual object state in the Genesys Configuration Database.

Specified by:
getObjectState in interface IGApplicationConfiguration.IGHost
Returns:
actual object state
See Also:
CfgHost.getState()

getUserProperties

public KeyValueCollection getUserProperties()
Returns pointer to the list of user-defined properties.
It represents the "Annex" tab of the host object in CME.

Specified by:
getUserProperties in interface IGApplicationConfiguration.IGHost
Returns:
collection of properties sections or null
See Also:
CfgHost.getUserProperties()

setName

public void setName(java.lang.String name)
Sets the host name.

Parameters:
name - the host name
See Also:
CfgHost.getName()

setDbid

public void setDbid(java.lang.Integer dbid)
Sets the host DBID.

Parameters:
dbid - the host object DBID
See Also:
CfgHost.getDBID()

setIPAddress

public void setIPAddress(java.lang.String ipaddress)
Sets the host TCP/IP address.

Parameters:
ipaddress - the host TCP/IP address
See Also:
CfgHost.getIPaddress()

setLCAPort

public void setLCAPort(java.lang.String lcaport)
Sets port number on which the Local Control Agent for this host is supposed to be running.

Parameters:
lcaport - the LCA port number
See Also:
CfgHost.getLCAPort()

setObjectState

public void setObjectState(CfgObjectState state)
Sets actual object state in the Genesys Configuration Database.

Parameters:
state - actual object state
See Also:
CfgHost.getState()

setUserProperties

public void setUserProperties(KeyValueCollection userProperties)
Sets pointer to the list of user-defined properties.
It represents the "Annex" tab of the host object in CME.

Parameters:
userProperties - collection of properties sections or null
See Also:
CfgHost.getUserProperties()

clone

public GApplicationConfiguration.GHost clone()
Overrides:
clone in class java.lang.Object

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

contentToString

protected java.lang.String contentToString()
This method is used from toString() to build string representation of the internal content (configuration properties names and values).

Returns:
string representation of the configuration content
See Also:
toString()

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.