|
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.CfgDelta
com.genesyslab.platform.applicationblocks.com.objects.CfgDeltaField
public class CfgDeltaField
The
CfgDeltaField
is applicable for Configuration
Library/Server release 5.1.5xx and later.
Constructor Summary | |
---|---|
CfgDeltaField(IConfService confService)
This constructor is intended for creation of detached objects. |
|
CfgDeltaField(IConfService confService,
ConfObjectDelta objData)
This constructor is intended for creation of delta objects from configuration protocol messages. |
|
CfgDeltaField(IConfService confService,
org.w3c.dom.Node xmlData)
This constructor is intended for creation of delta objects from configuration protocol messages. |
Method Summary | |
---|---|
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. |
KeyValueCollection |
getChangedUserProperties()
A pointer to the list of user-defined properties whose values have been changed. |
java.lang.Integer |
getDBID()
The DBID of the target CfgField configuration object. |
java.lang.String |
getDefaultValue()
A pointer to the default value of field. |
KeyValueCollection |
getDeletedUserProperties()
A pointer to the list of deleted user-defined properties. |
java.lang.String |
getDescription()
A pointer to the description of field. |
CfgFieldType |
getFieldType()
A field type. |
CfgFlag |
getIsNullable()
A flag which determines whether or not a field can allow null values ( NULLs ) for the data in that field. |
CfgFlag |
getIsPrimaryKey()
A flag which determines whether or not a field is used as primary key. |
CfgFlag |
getIsUnique()
A flag which determines whether or not a field is used as unique. |
java.lang.Integer |
getLength()
A length of field in data base. |
java.lang.String |
getName()
A field name in data base. |
CfgObjectState |
getState()
Current object state. |
CfgTenant |
getTenant()
A unique identifier of the
CfgTenant
that this field belongs to. |
java.lang.Integer |
getTenantDBID()
Retrieves the dbid of the object that is being linked to by the Tenant property. |
CfgDataType |
getType()
A data type of field in data base. |
CfgField |
retrieveCfgField()
Read base CfgField 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 |
---|
public CfgDeltaField(IConfService confService)
confService
- configuration service instancepublic CfgDeltaField(IConfService confService, ConfObjectDelta objData)
confService
- configuration service instanceobjData
- configuration protocol object delta datapublic CfgDeltaField(IConfService confService, org.w3c.dom.Node xmlData)
confService
- configuration service instancexmlData
- XML object containing object delta dataMethod Detail |
---|
public final java.lang.Integer getDBID()
public final CfgField retrieveCfgField() throws ConfigException
ConfigException
- in case of problem while object readingpublic final CfgTenant getTenant()
CfgTenant
that this field belongs to. Mandatory. Once specified, cannot be
changed.
public final java.lang.Integer getTenantDBID()
public final java.lang.String getName()
public final CfgDataType getType()
CfgDataType
public final java.lang.String getDescription()
public final java.lang.Integer getLength()
public final CfgFieldType getFieldType()
CfgFieldType
of
User Defined Variable types. Mandatory, once specified cannot be
changed.
public final java.lang.String getDefaultValue()
public final CfgFlag getIsPrimaryKey()
CfgFlag
public final CfgFlag getIsUnique()
CfgFlag
public final CfgFlag getIsNullable()
CfgFlag
public final CfgObjectState getState()
CfgObjectState
public final KeyValueCollection getAddedUserProperties()
public final KeyValueCollection getDeletedUserProperties()
public final KeyValueCollection getChangedUserProperties()
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |