|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.applicationblocks.com.CfgBase
com.genesyslab.platform.applicationblocks.com.CfgObject
com.genesyslab.platform.applicationblocks.com.objects.CfgTenant
public class CfgTenant
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:
tenantDBIDs
of all applications
associated with Tenant X (see
CfgApplication
)
CfgPerson
for
details)
CfgSwitch
for
details)
CfgEnumerator
for details)
CfgIVR
for
details)
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 assignedTenantDBID
within the
CfgService
object.
The tenant can not be deleted as long as contains persons
serving as accounts for some server objects
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 |
---|
public static final CfgObjectType OBJECT_TYPE
Constructor Detail |
---|
public CfgTenant(IConfService confService, ConfObject objData, boolean isSaved, java.lang.Object[] additionalParameters)
confService
- configuration service instanceobjData
- configuration protocol object data structureisSaved
- indicator of the object saved stateadditionalParameters
- additional parameters from configuration protocol messagepublic CfgTenant(IConfService confService, org.w3c.dom.Node xmlData, java.lang.Object[] additionalParameters)
confService
- configuration service instancexmlData
- XML object containing object dataadditionalParameters
- additional parameters from configuration protocol messagepublic CfgTenant(IConfService confService)
confService
- configuration service instanceMethod Detail |
---|
public void save() throws ConfigException
save
in interface ICfgObject
save
in class CfgObject
ConfigException
- in case of protocol level exception, data transformation,
or server side constraintspublic final java.lang.Integer getDBID()
public final void setDBID(java.lang.Integer value)
value
- new property valuegetDBID()
public final CfgFlag getIsServiceProvider()
CfgFlag
)
Read-only (set automatically when a tenant is created).
public final void setIsServiceProvider(CfgFlag value)
CfgFlag
)
Read-only (set automatically when a tenant is created).
value
- new property valuegetIsServiceProvider()
public final java.lang.String getName()
public final void setName(java.lang.String value)
value
- new property valuegetName()
public final java.lang.String getPassword()
public final void setPassword(java.lang.String value)
value
- new property valuegetPassword()
public final CfgAddress getAddress()
public final void setAddress(CfgAddress value)
value
- new property valuegetAddress()
public final java.lang.String getChargeableNumber()
public final void setChargeableNumber(java.lang.String value)
value
- new property valuegetChargeableNumber()
public final CfgObjectState getState()
CfgObjectState
public final void setState(CfgObjectState value)
CfgObjectState
value
- new property valuegetState()
public final KeyValueCollection getUserProperties()
public final void setUserProperties(KeyValueCollection value)
value
- new property valuegetUserProperties()
public final CfgScript getDefaultCapacityRule()
CfgScript
)
associated with this tenant.
public final void setDefaultCapacityRule(CfgScript value)
CfgScript
)
associated with this tenant.
value
- new property valuegetDefaultCapacityRule()
public final void setDefaultCapacityRuleDBID(int dbid)
CfgScript
)
associated with this tenant.
dbid
- DBID identifier of referred objectgetDefaultCapacityRule()
public final java.lang.Integer getDefaultCapacityRuleDBID()
public final CfgObjectiveTable getDefaultContract()
CfgObjectiveTable
)
associated with this tenant.
public final void setDefaultContract(CfgObjectiveTable value)
CfgObjectiveTable
)
associated with this tenant.
value
- new property valuegetDefaultContract()
public final void setDefaultContractDBID(int dbid)
CfgObjectiveTable
)
associated with this tenant.
dbid
- DBID identifier of referred objectgetDefaultContract()
public final java.lang.Integer getDefaultContractDBID()
public final CfgTenant getParentTenant()
public final void setParentTenant(CfgTenant value)
public final void setParentTenantDBID(int dbid)
public final java.lang.Integer getParentTenantDBID()
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |