Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgSubcode

java.lang.Object
  extended by com.genesyslab.platform.applicationblocks.com.CfgBase
      extended by com.genesyslab.platform.applicationblocks.com.CfgStructure
          extended by com.genesyslab.platform.applicationblocks.com.objects.CfgSubcode
All Implemented Interfaces:
ICfgBase, ICfgStructure

public class CfgSubcode
extends CfgStructure

You can use Subcodes to supplement Action Codes with more precise information about the reasons for a certain action.


Constructor Summary
CfgSubcode(IConfService confService, ConfStructure objData, ICfgObject parent)
          This constructor is intended for creation of structures from external or imported XML data.
CfgSubcode(IConfService confService, ICfgObject parent)
          This constructor is intended for creation of detached objects.
CfgSubcode(IConfService confService, org.w3c.dom.Node xmlData, ICfgObject parent)
          This constructor is intended for creation of structures from external or imported XML data.
 
Method Summary
 java.lang.String getCode()
          A pointer to the index or abbreviation of the subcode.
 java.lang.String getName()
          A pointer to the name of the subcode.
 void setCode(java.lang.String value)
          A pointer to the index or abbreviation of the subcode.
 void setName(java.lang.String value)
          A pointer to the name of the subcode.
 
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgStructure
getParent, updateChildrenSavedState
 
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgBase
clone, ensureDataBackup, equals, flushChildrenContent, getConfigurationService, getData, getEndpoint, getLinkListCollection, getLinkValue, getLogger, getMetaData, getProperty, getProperty, getProperty, getRawObjectData, hashCode, initStruct, isSaved, lockObject, reloadObjectWithNewData, 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.ICfgBase
getEndpoint, getProperty, getRawObjectData, setProperty, toXml
 

Constructor Detail

CfgSubcode

public CfgSubcode(IConfService confService,
                  ConfStructure objData,
                  ICfgObject parent)
This constructor is intended for creation of structures from external or imported XML data. It is internally used by COM AB for objects and structures deserialization.

Parameters:
confService - configuration service instance
objData - configuration protocol structure data
parent - instance of configuration object as a parent for this structure instance

CfgSubcode

public CfgSubcode(IConfService confService,
                  org.w3c.dom.Node xmlData,
                  ICfgObject parent)
This constructor is intended for creation of structures from external or imported XML data. It is internally used by COM AB for objects and structures deserialization.

Parameters:
confService - configuration service instance
xmlData - XML object containing structure data
parent - instance of configuration object as a parent for this structure instance

CfgSubcode

public CfgSubcode(IConfService confService,
                  ICfgObject parent)
This constructor is intended for creation of detached objects.

Parameters:
confService - configuration service instance
parent - instance of configuration object as a parent for this structure instance
Method Detail

getName

public final java.lang.String getName()
A pointer to the name of the subcode. Mandatory. Must be unique within the action code. Once specified, cannot be changed.

Returns:
property value or null

setName

public final void setName(java.lang.String value)
A pointer to the name of the subcode. Mandatory. Must be unique within the action code. Once specified, cannot be changed.

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

getCode

public final java.lang.String getCode()
A pointer to the index or abbreviation of the subcode. Mandatory. Once specified, cannot be changed.

Returns:
property value or null

setCode

public final void setCode(java.lang.String value)
A pointer to the index or abbreviation of the subcode. Mandatory. Once specified, cannot be changed.

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

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.