Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgSolutionComponentDefinition

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.CfgSolutionComponentDefinition
All Implemented Interfaces:
ICfgBase, ICfgStructure

public class CfgSolutionComponentDefinition
extends CfgStructure

CfgSolutionComponentDefinition lists the types of applications whose functionality this solution uses.


Constructor Summary
CfgSolutionComponentDefinition(IConfService confService, ConfStructure objData, ICfgObject parent)
          This constructor is intended for creation of structures from external or imported XML data.
CfgSolutionComponentDefinition(IConfService confService, ICfgObject parent)
          This constructor is intended for creation of detached objects.
CfgSolutionComponentDefinition(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
 CfgFlag getIsOptional()
          

Determines whether this solution component default value is optional.

 java.lang.Integer getStartupPriority()
          

The default number of the solution component in a component startup sequence within solution.

 CfgAppType getType()
          

Type of the application that is used as solution component.

 java.lang.String getVersion()
          A pointer to the application version that is used as solution component.
 void setIsOptional(CfgFlag value)
          

Determines whether this solution component default value is optional.

 void setStartupPriority(java.lang.Integer value)
          

The default number of the solution component in a component startup sequence within solution.

 void setType(CfgAppType value)
          

Type of the application that is used as solution component.

 void setVersion(java.lang.String value)
          A pointer to the application version that is used as solution component.
 
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

CfgSolutionComponentDefinition

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

CfgSolutionComponentDefinition

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

CfgSolutionComponentDefinition

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

getStartupPriority

public final java.lang.Integer getStartupPriority()

The default number of the solution component in a component startup sequence within solution. StartupPriority value should be used to determine the order in which components should be started and stopped. The value defined as default could be changed at time of SolutionComponent definition. Must be defined as positive integer. Mandatory. Must be shown as the READONLY property in an object of type CfgService (Solution).

Returns:
property value or null

setStartupPriority

public final void setStartupPriority(java.lang.Integer value)

The default number of the solution component in a component startup sequence within solution. StartupPriority value should be used to determine the order in which components should be started and stopped. The value defined as default could be changed at time of SolutionComponent definition. Must be defined as positive integer. Mandatory. Must be shown as the READONLY property in an object of type CfgService (Solution).

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

getIsOptional

public final CfgFlag getIsOptional()

Determines whether this solution component default value is optional. Recommended to be set to CFGFalse by default. Must be shown as READONLY property in object of type CfgService (Solution). Refers to CfgFlag

Returns:
property value or null

setIsOptional

public final void setIsOptional(CfgFlag value)

Determines whether this solution component default value is optional. Recommended to be set to CFGFalse by default. Must be shown as READONLY property in object of type CfgService (Solution). Refers to CfgFlag

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

getType

public final CfgAppType getType()

Type of the application that is used as solution component. Mandatory. Once specified, cannot be changed. See CfgAppType .

Returns:
property value or null

setType

public final void setType(CfgAppType value)

Type of the application that is used as solution component. 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 that is used as solution component. 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 that is used as solution component. Once specified, cannot be changed.

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

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.