Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgService

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

public class CfgService
extends CfgObject

Solutions are sets of functions that applications provide. Solutions accomplish particular business tasks in contact centers.

The components list of a solution can be populated based on the list of the componentDefinitions the solution is based on. Then, an application for each component within the solution should be assigned according to the type of application specified in SolutionComponentDefinition this solution component is based on and whether or not a solution component is mandatory or optional. Parameters appType, appVersion, and startupPriority are READONLY within solution.

It shall be possible to edit the components list of a solution in such a way that one or more copies of a solution component already defined within the solution can be created. If such a copy is made, a unique identifier of an application with the type suitable for the newly created component could be assigned to appDBID parameter in this component.

The fact that more than one solution component within a solution may have the same appType, appVersion and startupPriority implies that the order of activation of corresponding applications within the solution may be chosen arbitrarily.

For compatibility purposes between 5.1.xx and 5.9.xxx, objects of type CfgService that exist in 5.1.xxx release will have solutionType=CFGSTDefaultSolutionType.

If one solution component is used by two different solutions, both solutions should refer to same application of CFGSCS type (SCSDBID)

See also:

CfgDeltaService

CfgTenant

CfgApplication


Field Summary
static CfgObjectType OBJECT_TYPE
           
 
Constructor Summary
CfgService(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgService(IConfService confService, ConfObject objData, boolean isSaved, java.lang.Object[] additionalParameters)
          This constructor is intended for creation of objects from configuration protocol messages.
CfgService(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
 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<CfgSolutionComponentDefinition> getComponentDefinitions()
          

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

 java.util.Collection<CfgSolutionComponent> getComponents()
          A pointer to a list of solution components defined for this solution (every item of this list is structured as CfgSolutionComponent ).
 java.lang.Integer getDBID()
          An identifier of this object in the Configuration Database.
 java.lang.String getName()
          A pointer to the name of the service/solution.
 java.util.Collection<CfgObjectResource> getResources()
           
 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.

 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 version of the solution.
 void save()
          Synchronizes changes in the class with Configuration Server.
 void setAssignedTenant(CfgTenant value)
          

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

 void setAssignedTenantDBID(int dbid)
          

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

 void setComponentDefinitions(java.util.Collection<CfgSolutionComponentDefinition> value)
          

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

 void setComponents(java.util.Collection<CfgSolutionComponent> value)
          A pointer to a list of solution components defined for this solution (every item of this list is structured as CfgSolutionComponent ).
 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 service/solution.
 void setResources(java.util.Collection<CfgObjectResource> value)
           
 void setSCS(CfgApplication value)
          

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

 void setSCSDBID(int dbid)
          

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

 void setSolutionType(CfgSolutionType value)
          

The type of the solution.

 void setStartupType(CfgStartupType value)
          

A type of solution/service startup.

 void setState(CfgObjectState value)
          

Current object state.

 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 version of the solution.
 
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

CfgService

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

CfgService

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

CfgService

public CfgService(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 service/solution. Mandatory. 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 service/solution. Mandatory. Must be unique within the Configuration Database.

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

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()

getSolutionType

public final CfgSolutionType getSolutionType()

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

Returns:
property value or null

setSolutionType

public final void setSolutionType(CfgSolutionType value)

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

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

getComponents

public final java.util.Collection<CfgSolutionComponent> getComponents()
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

setComponents

public final void setComponents(java.util.Collection<CfgSolutionComponent> value)
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.

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

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

setSCS

public final void setSCS(CfgApplication value)

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

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

setSCSDBID

public final void setSCSDBID(int dbid)

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

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

getSCSDBID

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

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

setAssignedTenant

public final void setAssignedTenant(CfgTenant value)

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.

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

setAssignedTenantDBID

public final void setAssignedTenantDBID(int dbid)

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.

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

getAssignedTenantDBID

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

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

setVersion

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

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

getComponentDefinitions

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

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

setComponentDefinitions

public final void setComponentDefinitions(java.util.Collection<CfgSolutionComponentDefinition> value)

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

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

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

setStartupType

public final void setStartupType(CfgStartupType value)

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.

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

getResources

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

setResources

public final void setResources(java.util.Collection<CfgObjectResource> value)

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.