Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgScript

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

public class CfgScript
extends CfgObject

Scripts identify processing scenarios or treatments that can be applied to customer interactions.

Deletion of Script X will cause the following events set out in the order of arrival:



See also:

CfgDeltaScript


Field Summary
static CfgObjectType OBJECT_TYPE
           
 
Constructor Summary
CfgScript(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgScript(IConfService confService, ConfObject objData, boolean isSaved, java.lang.Object[] additionalParameters)
          This constructor is intended for creation of objects from configuration protocol messages.
CfgScript(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
 java.lang.Integer getDBID()
          An identifier of this object in the Configuration Database.
 java.lang.Integer getIndex()
          Script index.
 java.lang.String getName()
          A pointer to the name of the script.
 java.util.Collection<CfgObjectResource> getResources()
          A pointer to the list of the objects associated with this Host (every item of this list is structured as CfgObjectResource ).
 CfgObjectState getState()
          Current object state.
 CfgTenant getTenant()
          A unique identifier of the Tenant this script belongs to.
 java.lang.Integer getTenantDBID()
          Retrieves the dbid of the object that is being linked to by the Tenant property.
 CfgScriptType getType()
          Type of this script.
 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.
 void save()
          Synchronizes changes in the class with Configuration Server.
 void setDBID(java.lang.Integer value)
          An identifier of this object in the Configuration Database.
 void setIndex(java.lang.Integer value)
          Script index.
 void setName(java.lang.String value)
          A pointer to the name of the script.
 void setResources(java.util.Collection<CfgObjectResource> value)
          A pointer to the list of the objects associated with this Host (every item of this list is structured as CfgObjectResource ).
 void setState(CfgObjectState value)
          Current object state.
 void setTenant(CfgTenant value)
          A unique identifier of the Tenant this script belongs to.
 void setTenantDBID(int dbid)
          A unique identifier of the Tenant this script belongs to.
 void setType(CfgScriptType value)
          Type of this script.
 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.
 
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

CfgScript

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

CfgScript

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

CfgScript

public CfgScript(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 script. Mandatory. Must be unique within the tenant.

Returns:
property value or null

setName

public final void setName(java.lang.String value)
A pointer to the name of the script. Mandatory. Must be unique within the tenant.

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

getTenant

public final CfgTenant getTenant()
A unique identifier of the Tenant this script belongs to. Mandatory. Once specified, cannot be changed.

Returns:
instance of referred object or null

setTenant

public final void setTenant(CfgTenant value)
A unique identifier of the Tenant this script belongs to. Mandatory. Once specified, cannot be changed.

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

setTenantDBID

public final void setTenantDBID(int dbid)
A unique identifier of the Tenant this script belongs to. Mandatory. Once specified, cannot be changed.

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

getTenantDBID

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

Returns:
DBID identifier of referred object or null

getIndex

public final java.lang.Integer getIndex()
Script index.

Returns:
property value or null

setIndex

public final void setIndex(java.lang.Integer value)
Script index.

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

getType

public final CfgScriptType getType()
Type of this script. Mandatory. Once specified, cannot be changed. See type CfgScriptType

Returns:
property value or null

setType

public final void setType(CfgScriptType value)
Type of this script. Mandatory. Once specified, cannot be changed. See type CfgScriptType

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

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

getResources

public final java.util.Collection<CfgObjectResource> getResources()
A pointer to the list of the objects associated with this Host (every item of this list is structured as CfgObjectResource ). When used as an entry in CfgDeltaHost , it is a pointer to a list of resources added to the existing list. Only objects of type CfgAppPrototype and CfgScript and can be associated with Script object through resources

Returns:
list of structures or null

setResources

public final void setResources(java.util.Collection<CfgObjectResource> value)
A pointer to the list of the objects associated with this Host (every item of this list is structured as CfgObjectResource ). When used as an entry in CfgDeltaHost , it is a pointer to a list of resources added to the existing list. Only objects of type CfgAppPrototype and CfgScript and can be associated with Script object through resources

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

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.