Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgObjectiveTable

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

public class CfgObjectiveTable
extends CfgObject

Objective Tables are collections of Objective Records.

See also:

CfgDeltaObjectiveTable

CfgEnumeratorValue


Field Summary
static CfgObjectType OBJECT_TYPE
           
 
Constructor Summary
CfgObjectiveTable(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgObjectiveTable(IConfService confService, ConfObject objData, boolean isSaved, java.lang.Object[] additionalParameters)
          This constructor is intended for creation of objects from configuration protocol messages.
CfgObjectiveTable(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.String getDescription()
          A pointer to the description of the objective table.
 java.lang.String getName()
          A pointer to the name of the objective table.
 java.util.Collection<CfgObjectiveTableRecord> getObjectiveRecords()
          A pointer to the list of identifiers of objective records comprising this objective table.
 java.lang.Integer getPrepaidCost()
          A flat rate for the cost per call.
 CfgObjectState getState()
          Current object state.
 CfgTenant getTenant()
          A unique identifier of the CfgTenant to which this objective table is allocated.
 java.lang.Integer getTenantDBID()
          Retrieves the dbid of the object that is being linked to by the Tenant property.
 java.util.Calendar getTimeEnd()
          The date on which to end the Volume Rate Contract.
 java.util.Calendar getTimeStart()
          The date on which to start the Volume Rate Contract.
 CfgTimeZone getTimeZone()
          A CfgTimeZone associated with this Cost Contract
 java.lang.Integer getTimeZoneDBID()
          Retrieves the dbid of the object that is being linked to by the TimeZone property.
 CfgObjectiveTableType getType()
          Objective Table type.
 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 setDescription(java.lang.String value)
          A pointer to the description of the objective table.
 void setName(java.lang.String value)
          A pointer to the name of the objective table.
 void setObjectiveRecords(java.util.Collection<CfgObjectiveTableRecord> value)
          A pointer to the list of identifiers of objective records comprising this objective table.
 void setPrepaidCost(java.lang.Integer value)
          A flat rate for the cost per call.
 void setState(CfgObjectState value)
          Current object state.
 void setTenant(CfgTenant value)
          A unique identifier of the CfgTenant to which this objective table is allocated.
 void setTenantDBID(int dbid)
          A unique identifier of the CfgTenant to which this objective table is allocated.
 void setTimeEnd(java.util.Calendar value)
          The date on which to end the Volume Rate Contract.
 void setTimeStart(java.util.Calendar value)
          The date on which to start the Volume Rate Contract.
 void setTimeZone(CfgTimeZone value)
          A CfgTimeZone associated with this Cost Contract
 void setTimeZoneDBID(int dbid)
          A CfgTimeZone associated with this Cost Contract
 void setType(CfgObjectiveTableType value)
          Objective Table type.
 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

CfgObjectiveTable

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

CfgObjectiveTable

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

CfgObjectiveTable

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

getTenant

public final CfgTenant getTenant()
A unique identifier of the CfgTenant to which this objective table is allocated. 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 CfgTenant to which this objective table is allocated. 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 CfgTenant to which this objective table is allocated. 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

getName

public final java.lang.String getName()
A pointer to the name of the objective table. Mandatory. Must be unique within the tenant environment.

Returns:
property value or null

setName

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

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

getDescription

public final java.lang.String getDescription()
A pointer to the description of the objective table.

Returns:
property value or null

setDescription

public final void setDescription(java.lang.String value)
A pointer to the description of the objective table.

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

getObjectiveRecords

public final java.util.Collection<CfgObjectiveTableRecord> getObjectiveRecords()
A pointer to the list of identifiers of objective records comprising this objective table.

Returns:
list of structures or null

setObjectiveRecords

public final void setObjectiveRecords(java.util.Collection<CfgObjectiveTableRecord> value)
A pointer to the list of identifiers of objective records comprising this objective table.

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

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

getPrepaidCost

public final java.lang.Integer getPrepaidCost()
A flat rate for the cost per call.

Returns:
property value or null

setPrepaidCost

public final void setPrepaidCost(java.lang.Integer value)
A flat rate for the cost per call.

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

getTimeZone

public final CfgTimeZone getTimeZone()
A CfgTimeZone associated with this Cost Contract

Returns:
instance of referred object or null

setTimeZone

public final void setTimeZone(CfgTimeZone value)
A CfgTimeZone associated with this Cost Contract

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

setTimeZoneDBID

public final void setTimeZoneDBID(int dbid)
A CfgTimeZone associated with this Cost Contract

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

getTimeZoneDBID

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

Returns:
DBID identifier of referred object or null

getTimeStart

public final java.util.Calendar getTimeStart()
The date on which to start the Volume Rate Contract.

Returns:
property value or null

setTimeStart

public final void setTimeStart(java.util.Calendar value)
The date on which to start the Volume Rate Contract.

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

getTimeEnd

public final java.util.Calendar getTimeEnd()
The date on which to end the Volume Rate Contract.

Returns:
property value or null

setTimeEnd

public final void setTimeEnd(java.util.Calendar value)
The date on which to end the Volume Rate Contract.

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

getType

public final CfgObjectiveTableType getType()
Objective Table type. Refer to CfgObjectiveTableType

Returns:
property value or null

setType

public final void setType(CfgObjectiveTableType value)
Objective Table type. Refer to CfgObjectiveTableType

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

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.