|
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.CfgDeltaFormat
public class CfgDeltaFormat
The
CfgDeltaFormat
is applicable for Configuration
Library/Server release 5.1.5xx and later.
Constructor Summary | |
---|---|
CfgDeltaFormat(IConfService confService)
This constructor is intended for creation of detached objects. |
|
CfgDeltaFormat(IConfService confService,
ConfObjectDelta objData)
This constructor is intended for creation of delta objects from configuration protocol messages. |
|
CfgDeltaFormat(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<java.lang.Integer> |
getAddedFieldDBIDs()
A pointer to the list of identifiers of
CfgField
objects
that this format consists of. |
java.util.Collection<CfgField> |
getAddedFields()
A pointer to the list of identifiers of
CfgField
objects
that this format consists of. |
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 CfgFormat configuration object. |
java.util.Collection<java.lang.Integer> |
getDeletedFieldDBIDs()
A pointer to the list of deleted fields. |
java.util.Collection<CfgField> |
getDeletedFields()
A pointer to the list of deleted fields. |
KeyValueCollection |
getDeletedUserProperties()
A pointer to the list of deleted user-defined properties. |
java.lang.String |
getDescription()
A pointer to the description of format. |
java.util.Collection<java.lang.Integer> |
getFieldDBIDs()
Deprecated. |
java.lang.String |
getName()
A pointer to the name of the format. |
CfgObjectState |
getState()
Current object state. |
CfgTenant |
getTenant()
A unique identifier of the
CfgTenant
to which this format is allocated. |
java.lang.Integer |
getTenantDBID()
Retrieves the dbid of the object that is being linked to by the Tenant property. |
CfgFormat |
retrieveCfgFormat()
Read base CfgFormat 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 CfgDeltaFormat(IConfService confService)
confService
- configuration service instancepublic CfgDeltaFormat(IConfService confService, ConfObjectDelta objData)
confService
- configuration service instanceobjData
- configuration protocol object delta datapublic CfgDeltaFormat(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 CfgFormat retrieveCfgFormat() throws ConfigException
ConfigException
- in case of problem while object readingpublic final CfgTenant getTenant()
CfgTenant
to which this format is allocated. Mandatory. Once specified, cannot
be changed.
public final java.lang.Integer getTenantDBID()
public final java.lang.String getName()
public final java.lang.String getDescription()
public final java.util.Collection<CfgField> getAddedFields()
CfgField
objects
that this format consists of.
public final java.util.Collection<java.lang.Integer> getAddedFieldDBIDs()
CfgField
objects
that this format consists of.
@Deprecated public final java.util.Collection<java.lang.Integer> getFieldDBIDs()
getAddedFieldDBIDs()
public final CfgObjectState getState()
CfgObjectState
public final KeyValueCollection getAddedUserProperties()
public final java.util.Collection<CfgField> getDeletedFields()
public final java.util.Collection<java.lang.Integer> getDeletedFieldDBIDs()
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 |