Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgFolder

java.lang.Object
  extended by com.genesyslab.platform.applicationblocks.com.CfgBase
      extended by com.genesyslab.platform.applicationblocks.com.CfgObject
          extended by com.genesyslab.platform.applicationblocks.com.objects.CfgFolder
All Implemented Interfaces:
ICfgBase, ICfgObject, java.lang.Cloneable

public class CfgFolder
extends CfgObject

Folders can be used to create hierarchies of other types of objects. Each folder can contain a collection of objects of a single type.



See also:

CfgDeltaFolder


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

OBJECT_TYPE

public static final CfgObjectType OBJECT_TYPE
Constructor Detail

CfgFolder

public CfgFolder(IConfService confService,
                 ConfObject objData,
                 boolean isSaved,
                 java.lang.Object[] additionalParameters)
This constructor is intended for creation of objects from configuration protocol messages. It is internally used by COM AB for objects deserialization.

Parameters:
confService - configuration service instance
objData - configuration protocol object data structure
isSaved - indicator of the object saved state
additionalParameters - additional parameters from configuration protocol message

CfgFolder

public CfgFolder(IConfService confService,
                 org.w3c.dom.Node xmlData,
                 java.lang.Object[] additionalParameters)
This constructor is intended for creation of objects from configuration protocol messages. It is internally used by COM AB for objects deserialization.

Parameters:
confService - configuration service instance
xmlData - XML object containing object data
additionalParameters - additional parameters from configuration protocol message

CfgFolder

public CfgFolder(IConfService confService)
This constructor is intended for creation of detached objects.

Parameters:
confService - configuration service instance
Method Detail

save

public void save()
          throws ConfigException
Synchronizes changes in the class with Configuration Server.

Specified by:
save in interface ICfgObject
Overrides:
save in class CfgObject
Throws:
ConfigException - in case of protocol level exception, data transformation, or server side constraints

getDBID

public final java.lang.Integer getDBID()
An identifier of this object in the Configuration Database. Generated by Configuration Server and is unique within an object type. Identifiers of deleted objects are not used again. Read-only.

Returns:
property value or null

setDBID

public final void setDBID(java.lang.Integer value)
An identifier of this object in the Configuration Database. Generated by Configuration Server and is unique within an object type. Identifiers of deleted objects are not used again. Read-only.

Parameters:
value - new property value
See Also:
getDBID()

getName

public final java.lang.String getName()
A pointer to name of the folder. Mandatory. Must be unique within the parent object.

Returns:
property value or null

setName

public final void setName(java.lang.String value)
A pointer to name of the folder. Mandatory. Must be unique within the parent object.

Parameters:
value - new property value
See Also:
getName()

getType

public final CfgObjectType getType()
Type of the objects this folder may contain. A folder may contain either objects of this type or subfolders with the same value of type property. See the CfgObjectType enumeration.

Returns:
property value or null

setType

public final void setType(CfgObjectType value)
Type of the objects this folder may contain. A folder may contain either objects of this type or subfolders with the same value of type property. See the CfgObjectType enumeration.

Parameters:
value - new property value
See Also:
getType()

getOwnerID

public final CfgOwnerID getOwnerID()
A structure containing the object type and DBID of the folder's owner object. Unlike 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 .

Returns:
property value or null

setOwnerID

public final void setOwnerID(CfgOwnerID value)
A structure containing the object type and DBID of the folder's owner object. Unlike 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 .

Parameters:
value - new property value
See Also:
getOwnerID()

getState

public final CfgObjectState getState()
Current object state. Mandatory. Refer to CfgObjectState

Returns:
property value or null

setState

public final void setState(CfgObjectState value)
Current object state. Mandatory. Refer to CfgObjectState

Parameters:
value - new property value
See Also:
getState()

getUserProperties

public final 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.

Returns:
property value or null

setUserProperties

public final 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.

Parameters:
value - new property value
See Also:
getUserProperties()

getObjectIDs

public final java.util.Collection<CfgObjectID> getObjectIDs()
Pointer to the list of 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.

Returns:
list of structures or null

setObjectIDs

public final 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. Only objects of the type equal to the folder's type property or subfolders of this type may be contained in this list.

Parameters:
value - new property value
See Also:
getObjectIDs()

getParentID

public final CfgParentID getParentID()
A structure containing object type and DBID of the folder's parent, e.g. object which stands higher in the hierarchy. This may be another folder, if this folder is a subfolder, or this field may coincide with ownerID field if this folder is a topmost (default) one. A parent may an object of the following types: CfgFolder , CfgTenant , CfgSwitch , CfgIVR , or CfgEnumerator . See CfgID .

Returns:
property value or null

getDescription

public final java.lang.String getDescription()

setDescription

public final void setDescription(java.lang.String value)

getFolderClass

public final CfgFolderClass getFolderClass()
The class of the Folder.Refer to CfgFolderClass enumeration.

Returns:
property value or null

setFolderClass

public final void setFolderClass(CfgFolderClass value)
The class of the Folder.Refer to CfgFolderClass enumeration.

Parameters:
value - new property value
See Also:
getFolderClass()

getCustomType

public final java.lang.Integer getCustomType()
User classificator of the Folder. Optional.

Returns:
property value or null

setCustomType

public final void setCustomType(java.lang.Integer value)
User classificator of the Folder. Optional.

Parameters:
value - new property value
See Also:
getCustomType()

getResources

public final 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 ). 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

Returns:
list of structures or null

setResources

public final 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 ). 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

Parameters:
value - new property value
See Also:
getResources()

Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.