Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgAccessGroup

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.CfgAccessGroup
All Implemented Interfaces:
ICfgBase, ICfgObject, java.lang.Cloneable

public class CfgAccessGroup
extends CfgObject

Access Groups are groups of Persons who need to have the same set of permissions with respect to Configuration Database objects

The name of a access group must be unique within the tenant, but can coincide with the names of dn groups, place groups and agent groups of the same tenant.

See also:

CfgDeltaAccessGroup

CfgPerson


Field Summary
static CfgObjectType OBJECT_TYPE
           
 
Constructor Summary
CfgAccessGroup(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgAccessGroup(IConfService confService, ConfObject objData, boolean isSaved, java.lang.Object[] additionalParameters)
          This constructor is intended for creation of objects from configuration protocol messages.
CfgAccessGroup(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 getDBID()
          An identifier of this object in the Configuration Database.
 CfgGroup getGroupInfo()
          A pointer to the structure CfgGroup containing general information about this group.
 java.util.Collection<CfgID> getMemberIDs()
          A pointer to the list of the Persons that form this group (every item of this list is structured as CfgID ).
 CfgAccessGroupType getType()
          Type of this Access Group.
 void save()
          Synchronizes changes in the class with Configuration Server.
 void setDBID(java.lang.Integer value)
          An identifier of this object in the Configuration Database.
 void setGroupInfo(CfgGroup value)
          A pointer to the structure CfgGroup containing general information about this group.
 void setMemberIDs(java.util.Collection<CfgID> value)
          A pointer to the list of the Persons that form this group (every item of this list is structured as CfgID ).
 void setType(CfgAccessGroupType value)
          Type of this Access Group.
 
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

CfgAccessGroup

public CfgAccessGroup(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

CfgAccessGroup

public CfgAccessGroup(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

CfgAccessGroup

public CfgAccessGroup(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()

getGroupInfo

public final CfgGroup getGroupInfo()
A pointer to the structure CfgGroup containing general information about this group. Mandatory.

Returns:
property value or null

setGroupInfo

public final void setGroupInfo(CfgGroup value)
A pointer to the structure CfgGroup containing general information about this group. Mandatory.

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

getMemberIDs

public final java.util.Collection<CfgID> getMemberIDs()
A pointer to the list of the Persons that form this group (every item of this list is structured as CfgID ).

Returns:
list of structures or null

setMemberIDs

public final void setMemberIDs(java.util.Collection<CfgID> value)
A pointer to the list of the Persons that form this group (every item of this list is structured as CfgID ).

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

getType

public final CfgAccessGroupType getType()
Type of this Access Group. Once specified, cannot be changed. Refer to CfgAccessGroupType .

Returns:
property value or null

setType

public final void setType(CfgAccessGroupType value)
Type of this Access Group. Once specified, cannot be changed. Refer to CfgAccessGroupType .

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

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.