|
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.CfgFolder
public class CfgFolder
Folders can be used to create hierarchies of other types of objects. Each folder can contain a collection of objects of a single type.
type
property or subfolders of this
type.
CfgFolder
.
Unlike other folders, this folder can not contain ordinary objects,
but may contain folders of any type including folders of type
CfgFolder
(Configuration
Units)
Field Summary | |
---|---|
static CfgObjectType |
OBJECT_TYPE
|
Constructor Summary | |
---|---|
CfgFolder(IConfService confService)
This constructor is intended for creation of detached objects. |
|
CfgFolder(IConfService confService,
ConfObject objData,
boolean isSaved,
java.lang.Object[] additionalParameters)
This constructor is intended for creation of objects from configuration protocol messages. |
|
CfgFolder(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 |
getCustomType()
User classificator of the Folder. |
java.lang.Integer |
getDBID()
An identifier of this object in the Configuration Database. |
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. |
java.util.Collection<CfgObjectID> |
getObjectIDs()
Pointer to the list of
CfgObjectID
objects containing the type and DBID of the objects
subordinate to this 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. |
java.util.Collection<CfgObjectResource> |
getResources()
A pointer to the list of the objects associated with this Folder (every item of this list is structured as
CfgObjectResource
). |
CfgObjectState |
getState()
Current object state. |
CfgObjectType |
getType()
Type of the objects this folder may contain. |
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 |
setCustomType(java.lang.Integer value)
User classificator of the Folder. |
void |
setDBID(java.lang.Integer value)
An identifier of this object in the Configuration Database. |
void |
setDescription(java.lang.String value)
|
void |
setFolderClass(CfgFolderClass value)
The class of the Folder.Refer to
CfgFolderClass
enumeration. |
void |
setName(java.lang.String value)
A pointer to name of the folder. |
void |
setObjectIDs(java.util.Collection<CfgObjectID> value)
Pointer to the list of
CfgObjectID
objects containing the type and DBID of the objects
subordinate to this folder. |
void |
setOwnerID(CfgOwnerID value)
A structure containing the object type and DBID of the folder's owner object. |
void |
setResources(java.util.Collection<CfgObjectResource> value)
A pointer to the list of the objects associated with this Folder (every item of this list is structured as
CfgObjectResource
). |
void |
setState(CfgObjectState value)
Current object state. |
void |
setType(CfgObjectType value)
Type of the objects this folder may contain. |
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 CfgFolder(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 CfgFolder(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 CfgFolder(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 java.lang.String getName()
public final void setName(java.lang.String value)
value
- new property valuegetName()
public final CfgObjectType getType()
type
property. See the
CfgObjectType
enumeration.
public final void setType(CfgObjectType value)
type
property. See the
CfgObjectType
enumeration.
value
- new property valuegetType()
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 void setOwnerID(CfgOwnerID value)
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
.
value
- new property valuegetOwnerID()
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.util.Collection<CfgObjectID> getObjectIDs()
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 void setObjectIDs(java.util.Collection<CfgObjectID> value)
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.
value
- new property valuegetObjectIDs()
public final CfgParentID getParentID()
CfgFolder
,
CfgTenant
,
CfgSwitch
,
CfgIVR
, or
CfgEnumerator
.
See
CfgID
.
public final java.lang.String getDescription()
public final void setDescription(java.lang.String value)
public final CfgFolderClass getFolderClass()
CfgFolderClass
enumeration.
public final void setFolderClass(CfgFolderClass value)
CfgFolderClass
enumeration.
value
- new property valuegetFolderClass()
public final java.lang.Integer getCustomType()
public final void setCustomType(java.lang.Integer value)
value
- new property valuegetCustomType()
public final java.util.Collection<CfgObjectResource> getResources()
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 void setResources(java.util.Collection<CfgObjectResource> value)
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
value
- new property valuegetResources()
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |