|
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.CfgObjectiveTable
public class CfgObjectiveTable
Objective Tables are collections of Objective Records.
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 |
---|
public static final CfgObjectType OBJECT_TYPE
Constructor Detail |
---|
public CfgObjectiveTable(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 CfgObjectiveTable(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 CfgObjectiveTable(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 CfgTenant getTenant()
CfgTenant
to which this objective table is allocated. Mandatory. Once
specified, cannot be changed.
public final void setTenant(CfgTenant value)
CfgTenant
to which this objective table is allocated. Mandatory. Once
specified, cannot be changed.
value
- new property valuegetTenant()
public final void setTenantDBID(int dbid)
CfgTenant
to which this objective table is allocated. Mandatory. Once
specified, cannot be changed.
dbid
- DBID identifier of referred objectgetTenant()
public final java.lang.Integer getTenantDBID()
public final java.lang.String getName()
public final void setName(java.lang.String value)
value
- new property valuegetName()
public final java.lang.String getDescription()
public final void setDescription(java.lang.String value)
value
- new property valuegetDescription()
public final java.util.Collection<CfgObjectiveTableRecord> getObjectiveRecords()
public final void setObjectiveRecords(java.util.Collection<CfgObjectiveTableRecord> value)
value
- new property valuegetObjectiveRecords()
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 java.lang.Integer getPrepaidCost()
public final void setPrepaidCost(java.lang.Integer value)
value
- new property valuegetPrepaidCost()
public final CfgTimeZone getTimeZone()
CfgTimeZone
associated with this Cost Contract
public final void setTimeZone(CfgTimeZone value)
CfgTimeZone
associated with this Cost Contract
value
- new property valuegetTimeZone()
public final void setTimeZoneDBID(int dbid)
CfgTimeZone
associated with this Cost Contract
dbid
- DBID identifier of referred objectgetTimeZone()
public final java.lang.Integer getTimeZoneDBID()
public final java.util.Calendar getTimeStart()
public final void setTimeStart(java.util.Calendar value)
value
- new property valuegetTimeStart()
public final java.util.Calendar getTimeEnd()
public final void setTimeEnd(java.util.Calendar value)
value
- new property valuegetTimeEnd()
public final CfgObjectiveTableType getType()
CfgObjectiveTableType
public final void setType(CfgObjectiveTableType value)
CfgObjectiveTableType
value
- new property valuegetType()
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |