Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgTenant

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

public class CfgTenant
extends CfgObject

A Tenant is a business whose customer interactions are enabled or enhanced through services offered by a third party, typically a telecommunications service provider.

From a functional standpoint, each tenant in a multi-tenant environment is a contact center (single or multi-site) completely equipped to process customer interactions.

From an architectural standpoint, however, most of the hardware and software that tenants use to enable or enhance those interactions belongs to the service provider.

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

The following tenant is pre-defined (scripted) in the Configuration Database before Configuration Server is started for the first time:

 
 dbid = 1
 isServiceProvider = CFGTrue
 name = _Environment_
 password = empty string
 isSuperTenant = CFGFalse
 state = CFGEnabled
 
 

This tenant (with DBID=1) cannot be deleted or modified in any way

The association between a solution and a tenant should be made using assignedTenantDBIDwithin the CfgService object.

The tenant can not be deleted as long as contains persons serving as accounts for some server objects

See also:

CfgDeltaTenant


Field Summary
static CfgObjectType OBJECT_TYPE
           
 
Constructor Summary
CfgTenant(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgTenant(IConfService confService, ConfObject objData, boolean isSaved, java.lang.Object[] additionalParameters)
          This constructor is intended for creation of objects from configuration protocol messages.
CfgTenant(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
 CfgAddress getAddress()
          Not in use.
 java.lang.String getChargeableNumber()
          A pointer to the string value that is used for service charges of this tenant.
 java.lang.Integer getDBID()
          An identifier of this object in the Configuration Database.
 CfgScript getDefaultCapacityRule()
          

A unique identifier of the capacity rule ( CfgScript ) associated with this tenant.

 java.lang.Integer getDefaultCapacityRuleDBID()
          Retrieves the dbid of the object that is being linked to by the DefaultCapacityRule property.
 CfgObjectiveTable getDefaultContract()
          A unique identifier of the cost contract ( CfgObjectiveTable ) associated with this tenant.
 java.lang.Integer getDefaultContractDBID()
          Retrieves the dbid of the object that is being linked to by the DefaultContract property.
 CfgFlag getIsServiceProvider()
          An indicator of whether the tenant belongs to the Service Provider.
 java.lang.String getName()
          A pointer to name of the tenant.
 CfgTenant getParentTenant()
           
 java.lang.Integer getParentTenantDBID()
          Retrieves the dbid of the object that is being linked to by the ParentTenant property.
 java.lang.String getPassword()
          A pointer to the tenant password.
 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.
 void save()
          Synchronizes changes in the class with Configuration Server.
 void setAddress(CfgAddress value)
          Not in use.
 void setChargeableNumber(java.lang.String value)
          A pointer to the string value that is used for service charges of this tenant.
 void setDBID(java.lang.Integer value)
          An identifier of this object in the Configuration Database.
 void setDefaultCapacityRule(CfgScript value)
          

A unique identifier of the capacity rule ( CfgScript ) associated with this tenant.

 void setDefaultCapacityRuleDBID(int dbid)
          

A unique identifier of the capacity rule ( CfgScript ) associated with this tenant.

 void setDefaultContract(CfgObjectiveTable value)
          A unique identifier of the cost contract ( CfgObjectiveTable ) associated with this tenant.
 void setDefaultContractDBID(int dbid)
          A unique identifier of the cost contract ( CfgObjectiveTable ) associated with this tenant.
 void setIsServiceProvider(CfgFlag value)
          An indicator of whether the tenant belongs to the Service Provider.
 void setName(java.lang.String value)
          A pointer to name of the tenant.
 void setParentTenant(CfgTenant value)
           
 void setParentTenantDBID(int dbid)
           
 void setPassword(java.lang.String value)
          A pointer to the tenant password.
 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.
 
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

CfgTenant

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

CfgTenant

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

CfgTenant

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

getIsServiceProvider

public final CfgFlag getIsServiceProvider()
An indicator of whether the tenant belongs to the Service Provider. (see CfgFlag ) Read-only (set automatically when a tenant is created).

Returns:
property value or null

setIsServiceProvider

public final void setIsServiceProvider(CfgFlag value)
An indicator of whether the tenant belongs to the Service Provider. (see CfgFlag ) Read-only (set automatically when a tenant is created).

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

getName

public final java.lang.String getName()
A pointer to name of the tenant. 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 name of the tenant. Mandatory. Must be unique within the Configuration Database.

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

getPassword

public final java.lang.String getPassword()
A pointer to the tenant password. Max length 64 symbols.

Returns:
property value or null

setPassword

public final void setPassword(java.lang.String value)
A pointer to the tenant password. Max length 64 symbols.

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

getAddress

public final CfgAddress getAddress()
Not in use.

Returns:
property value or null

setAddress

public final void setAddress(CfgAddress value)
Not in use.

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

getChargeableNumber

public final java.lang.String getChargeableNumber()
A pointer to the string value that is used for service charges of this tenant. Max length 64 symbols.

Returns:
property value or null

setChargeableNumber

public final void setChargeableNumber(java.lang.String value)
A pointer to the string value that is used for service charges of this tenant. Max length 64 symbols.

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

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

getDefaultCapacityRule

public final CfgScript getDefaultCapacityRule()

A unique identifier of the capacity rule ( CfgScript ) associated with this tenant.

Returns:
instance of referred object or null

setDefaultCapacityRule

public final void setDefaultCapacityRule(CfgScript value)

A unique identifier of the capacity rule ( CfgScript ) associated with this tenant.

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

setDefaultCapacityRuleDBID

public final void setDefaultCapacityRuleDBID(int dbid)

A unique identifier of the capacity rule ( CfgScript ) associated with this tenant.

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

getDefaultCapacityRuleDBID

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

Returns:
DBID identifier of referred object or null

getDefaultContract

public final CfgObjectiveTable getDefaultContract()
A unique identifier of the cost contract ( CfgObjectiveTable ) associated with this tenant.

Returns:
instance of referred object or null

setDefaultContract

public final void setDefaultContract(CfgObjectiveTable value)
A unique identifier of the cost contract ( CfgObjectiveTable ) associated with this tenant.

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

setDefaultContractDBID

public final void setDefaultContractDBID(int dbid)
A unique identifier of the cost contract ( CfgObjectiveTable ) associated with this tenant.

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

getDefaultContractDBID

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

Returns:
DBID identifier of referred object or null

getParentTenant

public final CfgTenant getParentTenant()

setParentTenant

public final void setParentTenant(CfgTenant value)

setParentTenantDBID

public final void setParentTenantDBID(int dbid)

getParentTenantDBID

public final java.lang.Integer getParentTenantDBID()
Retrieves the dbid of the object that is being linked to by the ParentTenant 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.