Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgAppPrototype

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

public class CfgAppPrototype
extends CfgObject

An application prototype.

An application prototype cannot be deleted as long as there is at least one application associated with it.

Parameter options has the following structure: Each key-value pair of the primary list (TKVList *options) uses the key for the name of a configuration section, and the value for a secondary list, that also has the TKVList structure and specifies the configuration options defined within that section. Each key-value pair of the secondary list uses the key for the name of a configuration option, and the value for its current setting. Configuration options can be defined as variables of integer, character, or binary type. Names of sections must be unique within the primary list. Names of options must be unique within the secondary list. NOTE: Configuration Server is not concerned with logical meanings of application-specific configuration sections, options, or their values.

An application prototype of CFGConfigServer type with DBID set to 99 shall be pre-defined (scripted) in the Configuration Database before Configuration Server is started for the first time. The object that represents this application prototype cannot be deleted.

An application prototype of CFGSCE type with DBID set to 100 shall be pre-defined (scripted) in the Configuration Database before Configuration Server is started for the first time. The object that represents this application prototype cannot be deleted.

See also:

CfgDeltaAppPrototype


Field Summary
static CfgObjectType OBJECT_TYPE
           
 
Constructor Summary
CfgAppPrototype(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgAppPrototype(IConfService confService, ConfObject objData, boolean isSaved, java.lang.Object[] additionalParameters)
          This constructor is intended for creation of objects from configuration protocol messages.
CfgAppPrototype(IConfService confService, org.w3c.dom.Node xmlData, java.lang.Object[] additionalParameters)
          This constructor is intended for creation of objects from configuration protocol messages.
 
Method Summary
 java.lang.Integer getDBID()
          An identifier of this object in the Configuration Database.
 java.lang.String getName()
          A pointer to the name of the application prototype.
 KeyValueCollection getOptions()
          A pointer to the list of application-specific configuration options with default values where appropriate (see the comments below).
 CfgObjectState getState()
          Current object state.
 CfgAppType getType()
          Type of the application.
 KeyValueCollection getUserProperties()
          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.lang.String getVersion()
          A pointer to the application version.
 void save()
          Synchronizes changes in the class with Configuration Server.
 void setDBID(java.lang.Integer value)
          An identifier of this object in the Configuration Database.
 void setName(java.lang.String value)
          A pointer to the name of the application prototype.
 void setOptions(KeyValueCollection value)
          A pointer to the list of application-specific configuration options with default values where appropriate (see the comments below).
 void setState(CfgObjectState value)
          Current object state.
 void setType(CfgAppType value)
          Type of the application.
 void setUserProperties(KeyValueCollection value)
          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.
 void setVersion(java.lang.String value)
          A pointer to the application version.
 
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgObject
clone, delete, doSetFolderId, ensureDataBackup, getFolderId, getObjectDbid, getObjectPath, getObjectType, refresh, reloadObjectWithNewData, reloadObjectWithNewData, removeAccount, resetDataBackup, retrieveAccountPermissions, retrieveACL, retrievePermissions, setAccountPermissions, setAccountPermissions, setFolderId, update, 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, toStringProperties, 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
 

Field Detail

OBJECT_TYPE

public static final CfgObjectType OBJECT_TYPE
Constructor Detail

CfgAppPrototype

public CfgAppPrototype(IConfService confService,
                       ConfObject objData,
                       boolean isSaved,
                       java.lang.Object[] additionalParameters)
This constructor is intended for creation of objects from configuration protocol messages. It is internally used by COM AB for objects deserialization.

Parameters:
confService - configuration service instance
objData - configuration protocol object data structure
isSaved - indicator of the object saved state
additionalParameters - additional parameters from configuration protocol message

CfgAppPrototype

public CfgAppPrototype(IConfService confService,
                       org.w3c.dom.Node xmlData,
                       java.lang.Object[] additionalParameters)
This constructor is intended for creation of objects from configuration protocol messages. It is internally used by COM AB for objects deserialization.

Parameters:
confService - configuration service instance
xmlData - XML object containing object data
additionalParameters - additional parameters from configuration protocol message

CfgAppPrototype

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

Parameters:
confService - configuration service instance
Method Detail

save

public void save()
          throws ConfigException
Synchronizes changes in the class with Configuration Server.

Specified by:
save in interface ICfgObject
Overrides:
save in class CfgObject
Throws:
ConfigException - in case of protocol level exception, data transformation, or server side constraints

getDBID

public final java.lang.Integer getDBID()
An identifier of this object in the Configuration Database. Generated by Configuration Server and is unique within an object type. Identifiers of deleted objects are not used again. Read-only.

Returns:
property value or null

setDBID

public final void setDBID(java.lang.Integer value)
An identifier of this object in the Configuration Database. Generated by Configuration Server and is unique within an object type. Identifiers of deleted objects are not used again. Read-only.

Parameters:
value - new property value
See Also:
getDBID()

getName

public final java.lang.String getName()
A pointer to the name of the application prototype. Mandatory. Once specified, cannot be changed. Must be unique within the Configuration Database.

Returns:
property value or null

setName

public final void setName(java.lang.String value)
A pointer to the name of the application prototype. Mandatory. Once specified, cannot be changed. Must be unique within the Configuration Database.

Parameters:
value - new property value
See Also:
getName()

getType

public final CfgAppType getType()
Type of the application. Mandatory. Once specified, cannot be changed. See CfgAppType .

Returns:
property value or null

setType

public final void setType(CfgAppType value)
Type of the application. Mandatory. Once specified, cannot be changed. See CfgAppType .

Parameters:
value - new property value
See Also:
getType()

getVersion

public final java.lang.String getVersion()
A pointer to the application version. Once specified, cannot be changed.

Returns:
property value or null

setVersion

public final void setVersion(java.lang.String value)
A pointer to the application version. Once specified, cannot be changed.

Parameters:
value - new property value
See Also:
getVersion()

getOptions

public final KeyValueCollection getOptions()
A pointer to the list of application-specific configuration options with default values where appropriate (see the comments below). When used as an entry in CfgDeltaApplication, it is a pointer to a list of options added to the existing list.

Returns:
property value or null

setOptions

public final void setOptions(KeyValueCollection value)
A pointer to the list of application-specific configuration options with default values where appropriate (see the comments below). When used as an entry in CfgDeltaApplication, it is a pointer to a list of options added to the existing list.

Parameters:
value - new property value
See Also:
getOptions()

getState

public final CfgObjectState getState()
Current object state. Mandatory. Refer to CfgObjectState

Returns:
property value or null

setState

public final void setState(CfgObjectState value)
Current object state. Mandatory. Refer to CfgObjectState

Parameters:
value - new property value
See Also:
getState()

getUserProperties

public final KeyValueCollection getUserProperties()
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

setUserProperties

public final void setUserProperties(KeyValueCollection value)
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.

Parameters:
value - new property value
See Also:
getUserProperties()

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.