|
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.CfgDeltaFolder
public class CfgDeltaFolder
The changes to make to a
CfgFolder
object.
Constructor Summary | |
---|---|
CfgDeltaFolder(IConfService confService)
This constructor is intended for creation of detached objects. |
|
CfgDeltaFolder(IConfService confService,
ConfObjectDelta objData)
This constructor is intended for creation of delta objects from configuration protocol messages. |
|
CfgDeltaFolder(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<CfgObjectID> |
getAddedObjectIDs()
Pointer to the list of
CfgObjectID
objects containing the type and DBID of the objects
subordinate to this folder. |
java.util.Collection<CfgObjectResource> |
getAddedResources()
A pointer to the list of the objects associated with this Folder (every item of this list is structured as
CfgObjectResource
). |
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. |
java.util.Collection<CfgObjectResource> |
getChangedResources()
A pointer to the list of structures
CfgObjectResource
type. |
KeyValueCollection |
getChangedUserProperties()
A pointer to the list of user-defined properties whose values have been changed. |
java.lang.Integer |
getCustomType()
User classificator of the Folder. |
java.lang.Integer |
getDBID()
The DBID of the target CfgFolder configuration object. |
java.util.Collection<CfgObjectID> |
getDeletedObjectIDs()
A pointer to a list of subordinate objects excluded from the folder's container list. |
java.util.Collection<CfgResourceID> |
getDeletedResources()
A pointer to the list of deleted resources (every item of this list is structured as
CfgID
). |
KeyValueCollection |
getDeletedUserProperties()
A pointer to the list of deleted user-defined properties. |
java.lang.String |
getDescription()
|
CfgFolderClass |
getFolderClass()
The class of the Folder.Refer to
CfgFolderClass
enumeration. |
java.lang.String |
getName()
A pointer to name of the folder. |
CfgOwnerID |
getOwnerID()
A structure containing the object type and DBID of the folder's owner object. |
CfgParentID |
getParentID()
A structure containing object type and DBID of the folder's parent, e.g. |
CfgObjectState |
getState()
Current object state. |
CfgObjectType |
getType()
Type of the objects this folder may contain. |
CfgFolder |
retrieveCfgFolder()
Read base CfgFolder 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 CfgDeltaFolder(IConfService confService)
confService
- configuration service instancepublic CfgDeltaFolder(IConfService confService, ConfObjectDelta objData)
confService
- configuration service instanceobjData
- configuration protocol object delta datapublic CfgDeltaFolder(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 CfgFolder retrieveCfgFolder() throws ConfigException
ConfigException
- in case of problem while object readingpublic final java.lang.String getName()
public final CfgObjectType getType()
type
property. See the
CfgObjectType
enumeration.
public final CfgOwnerID getOwnerID()
parentID
, this field defines the folder's logical
affiliation rather than its hierarchical affiliation. An owner may be an object of
the following types:
CfgTenant
,
CfgSwitch
,
CfgIVR
,
or
CfgEnumerator
.
See
CfgID
.
public final CfgObjectState getState()
CfgObjectState
public final KeyValueCollection getAddedUserProperties()
public final java.util.Collection<CfgObjectID> getAddedObjectIDs()
CfgObjectID
objects containing the type and DBID of the objects
subordinate to this folder. Only objects of the type equal to the
folder's type property
or subfolders of this type may be contained in this list.
public final CfgParentID getParentID()
CfgFolder
,
CfgTenant
,
CfgSwitch
,
CfgIVR
, or
CfgEnumerator
.
See
CfgID
.
public final java.lang.String getDescription()
public final CfgFolderClass getFolderClass()
CfgFolderClass
enumeration.
public final java.lang.Integer getCustomType()
public final java.util.Collection<CfgObjectResource> getAddedResources()
CfgObjectResource
). When used as an entry
in
CfgDeltaFolder
, it is a pointer to a list of resources
added to the existing list.
Only objects of type
CfgFolder
,
CfgObjectiveTable
,
CfgGVPIVRProfile
,
CfgGVPCustomer
,
CfgTimeZone
,
CfgHost
can be associated with Folder object through resources
public final KeyValueCollection getDeletedUserProperties()
public final KeyValueCollection getChangedUserProperties()
public final java.util.Collection<CfgObjectID> getDeletedObjectIDs()
CfgID
.
public final java.util.Collection<CfgResourceID> getDeletedResources()
CfgID
).
public final java.util.Collection<CfgObjectResource> getChangedResources()
CfgObjectResource
type. Each structure contains
information about the resource parameters that have been changed.
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |