Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgSolutionComponent

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

public class CfgSolutionComponent
extends CfgStructure

CfgSolutionComponent displays a list of applications whose functionality this solution uses.


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

A unique identifier of an Application with type appType and version appVersion Mandatory (application must be specified within solution) for solution components within a solution if isOptional is set to CFGFalse.

 java.lang.Integer getAppDBID()
          Retrieves the dbid of the object that is being linked to by the App property.
 CfgFlag getIsOptional()
          

Determines whether this solution component is optional.

 java.lang.Integer getStartupPriority()
          The startup priority of the solution component in a component sequence.
 void setApp(CfgApplication value)
          

A unique identifier of an Application with type appType and version appVersion Mandatory (application must be specified within solution) for solution components within a solution if isOptional is set to CFGFalse.

 void setAppDBID(int dbid)
          

A unique identifier of an Application with type appType and version appVersion Mandatory (application must be specified within solution) for solution components within a solution if isOptional is set to CFGFalse.

 void setIsOptional(CfgFlag value)
          

Determines whether this solution component is optional.

 void setStartupPriority(java.lang.Integer value)
          The startup priority of the solution component in a component sequence.
 
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

CfgSolutionComponent

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

CfgSolutionComponent

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

CfgSolutionComponent

public CfgSolutionComponent(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 startup priority of the solution component in a component sequence. Component numbers should be used to determine the order in which components should be started and stopped. Must be defined as positive integer. Mandatory. Once specified cannot be changed. Must be shown as READONLY property in object of type CfgService (Solution).

Returns:
property value or null

setStartupPriority

public final void setStartupPriority(java.lang.Integer value)
The startup priority of the solution component in a component sequence. Component numbers should be used to determine the order in which components should be started and stopped. Must be defined as positive integer. Mandatory. Once specified cannot be changed. Must be shown as READONLY property in object of type CfgService (Solution).

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

getIsOptional

public final CfgFlag getIsOptional()

Determines whether this solution component 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 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()

getApp

public final CfgApplication getApp()

A unique identifier of an Application with type appType and version appVersion Mandatory (application must be specified within solution) for solution components within a solution if isOptional is set to CFGFalse. The application could be chosen from the list of applications based on application template/prototype specified in appPrototypeDBID.

Returns:
instance of referred object or null

setApp

public final void setApp(CfgApplication value)

A unique identifier of an Application with type appType and version appVersion Mandatory (application must be specified within solution) for solution components within a solution if isOptional is set to CFGFalse. The application could be chosen from the list of applications based on application template/prototype specified in appPrototypeDBID.

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

setAppDBID

public final void setAppDBID(int dbid)

A unique identifier of an Application with type appType and version appVersion Mandatory (application must be specified within solution) for solution components within a solution if isOptional is set to CFGFalse. The application could be chosen from the list of applications based on application template/prototype specified in appPrototypeDBID.

Parameters:
dbid - DBID identifier of referred object
See Also:
getApp()

getAppDBID

public final java.lang.Integer getAppDBID()
Retrieves the dbid of the object that is being linked to by the App property.

Returns:
DBID identifier of referred object 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.