Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgDeltaService

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.CfgDelta
              extended by com.genesyslab.platform.applicationblocks.com.objects.CfgDeltaService
All Implemented Interfaces:
ICfgBase, ICfgDelta, ICfgObject, java.lang.Cloneable

public class CfgDeltaService
extends CfgDelta

The changes to make to a CfgService object.


Constructor Summary
CfgDeltaService(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgDeltaService(IConfService confService, ConfObjectDelta objData)
          This constructor is intended for creation of delta objects from configuration protocol messages.
CfgDeltaService(IConfService confService, org.w3c.dom.Node xmlData)
          This constructor is intended for creation of delta objects from configuration protocol messages.
 
Method Summary
 java.lang.String getAbbr()
          Not in use.
 java.util.Collection<CfgAppServicePermission> getAddedAppServicePermissions()
          Not in use.
 java.util.Collection<CfgSolutionComponentDefinition> getAddedComponentDefinitions()
          

A pointer to a list of predefined solution components for this solution.

 java.util.Collection<CfgSolutionComponent> getAddedComponents()
          A pointer to a list of solution components defined for this solution (every item of this list is structured as CfgSolutionComponent ).
 java.util.Collection<CfgObjectResource> getAddedResources()
           
 KeyValueCollection getAddedUserProperties()
          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.
 CfgTenant getAssignedTenant()
          

A unique identifier of the Tenant the solution is assigned to.

 java.lang.Integer getAssignedTenantDBID()
          Retrieves the dbid of the object that is being linked to by the AssignedTenant property.
 java.util.Collection<CfgAppServicePermission> getChangedAppServicePermissions()
          Not in use.
 java.util.Collection<CfgSolutionComponentDefinition> getChangedComponentDefinitions()
          

A pointer to a list of structures of type CfgSolutionComponentDefinition that contain information about solution component definition within this solution whose parameters have been changed.

 java.util.Collection<CfgSolutionComponent> getChangedComponents()
          

A pointer to a list of structures of type CfgSolutionComponent that contain information about solution components within this solution whose parameters have been changed.

 java.util.Collection<CfgObjectResource> getChangedResources()
           
 KeyValueCollection getChangedUserProperties()
          A pointer to the list of user-defined properties whose values have been changed.
 java.lang.Integer getDBID()
          The DBID of the target CfgService configuration object.
 java.util.Collection<CfgAppServicePermission> getDeletedAppServicePermissions()
          Not in use.
 java.util.Collection<CfgSolutionComponentDefinition> getDeletedComponentDefinitions()
          

A pointer to a list of structures of type CfgSolutionComponentDefinition that contain information about solution component definition that are no longer defined within this solution.

 java.util.Collection<CfgSolutionComponent> getDeletedComponents()
          

A pointer to a list of structures of type CfgSolutionComponent that contain information about solution components that are no longer defined within this solution.

 java.util.Collection<CfgResourceID> getDeletedResources()
           
 KeyValueCollection getDeletedUserProperties()
          A pointer to the list of deleted user-defined properties.
 java.lang.String getName()
          A pointer to the name of the service/solution.
 CfgApplication getSCS()
          

A unique identifier of an Application of CFGSCStype which is supposed to control the solution.

 java.lang.Integer getSCSDBID()
          Retrieves the dbid of the object that is being linked to by the SCS property.
 CfgSolutionType getSolutionType()
          

The type of the solution.

 CfgStartupType getStartupType()
          

A type of solution/service startup.

 CfgObjectState getState()
          

Current object state.

 CfgChargeType getType()
          Not in use.
 java.lang.String getVersion()
          A pointer to the version of the solution.
 CfgService retrieveCfgService()
          Read base CfgService configuration object caused this event.
 
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgDelta
ensureDataBackup, retrieveObject, save, toStringProperties, update
 
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgObject
clone, delete, doSetFolderId, getFolderId, getObjectDbid, getObjectPath, getObjectType, refresh, reloadObjectWithNewData, reloadObjectWithNewData, removeAccount, resetDataBackup, retrieveAccountPermissions, retrieveACL, retrievePermissions, setAccountPermissions, setAccountPermissions, setFolderId, 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, 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
 

Constructor Detail

CfgDeltaService

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

Parameters:
confService - configuration service instance

CfgDeltaService

public CfgDeltaService(IConfService confService,
                       ConfObjectDelta objData)
This constructor is intended for creation of delta objects from configuration protocol messages. It is internally used by COM AB for delta objects deserialization.

Parameters:
confService - configuration service instance
objData - configuration protocol object delta data

CfgDeltaService

public CfgDeltaService(IConfService confService,
                       org.w3c.dom.Node xmlData)
This constructor is intended for creation of delta objects from configuration protocol messages. It is internally used by COM AB for delta objects deserialization.

Parameters:
confService - configuration service instance
xmlData - XML object containing object delta data
Method Detail

getDBID

public final java.lang.Integer getDBID()
The DBID of the target CfgService configuration object.

Returns:
target object DBID

retrieveCfgService

public final CfgService retrieveCfgService()
                                    throws ConfigException
Read base CfgService configuration object caused this event.

Returns:
configuration object read
Throws:
ConfigException - in case of problem while object reading

getName

public final java.lang.String getName()
A pointer to the name of the service/solution. Mandatory. Must be unique within the Configuration Database.

Returns:
property value or null

getAbbr

public final java.lang.String getAbbr()
Not in use.

Returns:
property value or null

getType

public final CfgChargeType getType()
Not in use.

Returns:
property value or null

getAddedAppServicePermissions

public final java.util.Collection<CfgAppServicePermission> getAddedAppServicePermissions()
Not in use.

Returns:
list of structures or null

getState

public final CfgObjectState getState()

Current object state. Mandatory. Refer to CfgObjectState

Returns:
property value or null

getAddedUserProperties

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

getSolutionType

public final CfgSolutionType getSolutionType()

The type of the solution. Mandatory. Once specified cannot be changed. See CfgSolutionType .

Returns:
property value or null

getAddedComponents

public final java.util.Collection<CfgSolutionComponent> getAddedComponents()
A pointer to a list of solution components defined for this solution (every item of this list is structured as CfgSolutionComponent ). When used as an entry in CfgDeltaService, it is a pointer to a list of solution components added to the existing list.

Returns:
list of structures or null

getSCS

public final CfgApplication getSCS()

A unique identifier of an Application of CFGSCStype which is supposed to control the solution. See comment number 4. See also CfgSolutionComponent .

Returns:
instance of referred object or null

getSCSDBID

public final java.lang.Integer getSCSDBID()
Retrieves the dbid of the object that is being linked to by the SCS property. Configuration server provides it only if the property value has been changed.

Returns:
DBID identifier of referred object or null

getAssignedTenant

public final CfgTenant getAssignedTenant()

A unique identifier of the Tenant the solution is assigned to. Optional. If assignedTenantDBID is managed (added/modified/removed) by configuration wizard , the same action (add/modify/remove) has to be initiated by wizard for property tenantDBIDs of CfgApplication if an application belongs to this solution.

Returns:
instance of referred object or null

getAssignedTenantDBID

public final java.lang.Integer getAssignedTenantDBID()
Retrieves the dbid of the object that is being linked to by the AssignedTenant property. Configuration server provides it only if the property value has been changed.

Returns:
DBID identifier of referred object or null

getVersion

public final java.lang.String getVersion()
A pointer to the version of the solution. Mandatory.

Returns:
property value or null

getAddedComponentDefinitions

public final java.util.Collection<CfgSolutionComponentDefinition> getAddedComponentDefinitions()

A pointer to a list of predefined solution components for this solution. (Every item of this list is structured as a CfgSolutionComponentDefinition .)

Returns:
list of structures or null

getStartupType

public final CfgStartupType getStartupType()

A type of solution/service startup. Specifies whether this solution/service have to be started by Management Layer. See CfgStartupType. Read-only. Specified during application prototype definition. The value is associated with solution type CfgSolutionType. The value for the solutions of CFGSTDefaultSolutionType and CFGSTFramework type is set to CFGSUTManual, and for other applications is set to CFGSUTAutomatic.

Returns:
property value or null

getAddedResources

public final java.util.Collection<CfgObjectResource> getAddedResources()

getDeletedAppServicePermissions

public final java.util.Collection<CfgAppServicePermission> getDeletedAppServicePermissions()
Not in use.

Returns:
list of numeric values or null

getChangedAppServicePermissions

public final java.util.Collection<CfgAppServicePermission> getChangedAppServicePermissions()
Not in use.

Returns:
list of structures or null

getDeletedUserProperties

public final KeyValueCollection getDeletedUserProperties()
A pointer to the list of deleted user-defined properties. Has the same structure as parameter userProperties.

Returns:
property value or null

getChangedUserProperties

public final KeyValueCollection getChangedUserProperties()
A pointer to the list of user-defined properties whose values have been changed. Has the same structure as parameter userProperties

Returns:
property value or null

getDeletedComponents

public final java.util.Collection<CfgSolutionComponent> getDeletedComponents()

A pointer to a list of structures of type CfgSolutionComponent that contain information about solution components that are no longer defined within this solution.

Returns:
list of structures or null

getChangedComponents

public final java.util.Collection<CfgSolutionComponent> getChangedComponents()

A pointer to a list of structures of type CfgSolutionComponent that contain information about solution components within this solution whose parameters have been changed.

Returns:
list of structures or null

getDeletedComponentDefinitions

public final java.util.Collection<CfgSolutionComponentDefinition> getDeletedComponentDefinitions()

A pointer to a list of structures of type CfgSolutionComponentDefinition that contain information about solution component definition that are no longer defined within this solution.

Returns:
list of structures or null

getChangedComponentDefinitions

public final java.util.Collection<CfgSolutionComponentDefinition> getChangedComponentDefinitions()

A pointer to a list of structures of type CfgSolutionComponentDefinition that contain information about solution component definition within this solution whose parameters have been changed.

Returns:
list of structures or null

getDeletedResources

public final java.util.Collection<CfgResourceID> getDeletedResources()

getChangedResources

public final java.util.Collection<CfgObjectResource> getChangedResources()

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.