Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgDeltaTenant

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

public class CfgDeltaTenant
extends CfgDelta

The changes to make to a CfgTenant object.

See also:

CfgTenant


Constructor Summary
CfgDeltaTenant(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgDeltaTenant(IConfService confService, ConfObjectDelta objData)
          This constructor is intended for creation of delta objects from configuration protocol messages.
CfgDeltaTenant(IConfService confService, org.w3c.dom.Node xmlData)
          This constructor is intended for creation of delta objects from configuration protocol messages.
 
Method Summary
 java.util.Collection<CfgServiceInfo> getAddedServiceInfo()
          Not in use.
 java.util.Collection<java.lang.Integer> getAddedTenantDBIDs()
          Not in use.
 java.util.Collection<CfgTenant> getAddedTenants()
          Not in use.
 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.
 CfgAddress getAddress()
          Not in use.
 java.util.Collection<CfgServiceInfo> getChangedServiceInfo()
          Not in use.
 KeyValueCollection getChangedUserProperties()
          A pointer to the list of user-defined properties whose values have been changed.
 java.lang.String getChargeableNumber()
          A pointer to the string value that is used for service charges of this tenant.
 java.lang.Integer getDBID()
          The DBID of the target CfgTenant configuration object.
 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.
 java.util.Collection<java.lang.Integer> getDeletedServiceDBIDs()
          Not in use.
 java.util.Collection<CfgServiceInfo> getDeletedServices()
          Not in use.
 java.util.Collection<java.lang.Integer> getDeletedTenantDBIDs()
          Not in use.
 java.util.Collection<CfgTenant> getDeletedTenants()
          Not in use.
 KeyValueCollection getDeletedUserProperties()
          A pointer to the list of deleted user-defined properties.
 CfgFlag getIsServiceProvider()
          An indicator of whether the tenant belongs to the Service Provider.
 CfgFlag getIsSuperTenant()
          Not in use.
 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.
 CfgPerson getProviderPerson()
          Not in use.
 java.lang.Integer getProviderPersonDBID()
          Retrieves the dbid of the object that is being linked to by the ProviderPerson property.
 CfgObjectState getState()
          

Current object state.

 java.util.Collection<java.lang.Integer> getTenantDBIDs()
          Deprecated.  
 CfgPerson getTenantPerson()
          Not in use.
 java.lang.Integer getTenantPersonDBID()
          Retrieves the dbid of the object that is being linked to by the TenantPerson property.
 CfgTenant retrieveCfgTenant()
          Read base CfgTenant 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

CfgDeltaTenant

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

Parameters:
confService - configuration service instance

CfgDeltaTenant

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

CfgDeltaTenant

public CfgDeltaTenant(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 CfgTenant configuration object.

Returns:
target object DBID

retrieveCfgTenant

public final CfgTenant retrieveCfgTenant()
                                  throws ConfigException
Read base CfgTenant configuration object caused this event.

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

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

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

getPassword

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

Returns:
property value or null

getAddress

public final CfgAddress getAddress()
Not in use.

Returns:
property value or null

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

getTenantPerson

public final CfgPerson getTenantPerson()
Not in use.

Returns:
instance of referred object or null

getTenantPersonDBID

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

Returns:
DBID identifier of referred object or null

getProviderPerson

public final CfgPerson getProviderPerson()
Not in use.

Returns:
instance of referred object or null

getProviderPersonDBID

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

Returns:
DBID identifier of referred object or null

getAddedServiceInfo

public final java.util.Collection<CfgServiceInfo> getAddedServiceInfo()
Not in use.

Returns:
list of structures or null

getIsSuperTenant

public final CfgFlag getIsSuperTenant()
Not in use.

Returns:
property value or null

getAddedTenants

public final java.util.Collection<CfgTenant> getAddedTenants()
Not in use.

Returns:
list of configuration objects or null

getAddedTenantDBIDs

public final java.util.Collection<java.lang.Integer> getAddedTenantDBIDs()
Not in use.

Returns:
collection of DBID identifiers of referred objects or null

getTenantDBIDs

@Deprecated
public final java.util.Collection<java.lang.Integer> getTenantDBIDs()
Deprecated. 

See Also:
getAddedTenantDBIDs()

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

getDefaultCapacityRule

public final CfgScript getDefaultCapacityRule()

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

Returns:
instance of referred object or null

getDefaultCapacityRuleDBID

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

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

getDefaultContractDBID

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

Returns:
DBID identifier of referred object or null

getParentTenant

public final CfgTenant getParentTenant()

getParentTenantDBID

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

Returns:
DBID identifier of referred object or null

getDeletedServices

public final java.util.Collection<CfgServiceInfo> getDeletedServices()
Not in use.

Returns:
list of configuration objects or null

getDeletedServiceDBIDs

public final java.util.Collection<java.lang.Integer> getDeletedServiceDBIDs()
Not in use.

Returns:
collection of DBID identifiers of referred objects or null

getChangedServiceInfo

public final java.util.Collection<CfgServiceInfo> getChangedServiceInfo()
Not in use.

Returns:
list of structures or null

getDeletedTenants

public final java.util.Collection<CfgTenant> getDeletedTenants()
Not in use.

Returns:
list of configuration objects or null

getDeletedTenantDBIDs

public final java.util.Collection<java.lang.Integer> getDeletedTenantDBIDs()
Not in use.

Returns:
collection of DBID identifiers of referred objects 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

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.