Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgAppRank

java.lang.Object
  extended by com.genesyslab.platform.applicationblocks.com.CfgBase
      extended by com.genesyslab.platform.applicationblocks.com.CfgStructure
          extended by com.genesyslab.platform.applicationblocks.com.objects.CfgAppRank
All Implemented Interfaces:
ICfgBase, ICfgStructure

public class CfgAppRank
extends CfgStructure

Ranks allow Applications to control which of their functions to make available to the currently logged-in Person.

Due to the introduction of a flexible access control system in Configuration Server version 5.1.100, the only purpose left for application ranks is to control what functionality of a certain application is available to the currently logged-on person. The decision on whether to use rank-based access to application's functions, and what functions to block/enable for what rank shall be determined exclusively by the feature requirements to that application type and made part of the functional specification for that application type. Level of access of a particular person to the Configuration Database objects does not depend in any way on the set of application ranks of that person.


Constructor Summary
CfgAppRank(IConfService confService, ConfStructure objData, ICfgObject parent)
          This constructor is intended for creation of structures from external or imported XML data.
CfgAppRank(IConfService confService, ICfgObject parent)
          This constructor is intended for creation of detached objects.
CfgAppRank(IConfService confService, org.w3c.dom.Node xmlData, ICfgObject parent)
          This constructor is intended for creation of structures from external or imported XML data.
 
Method Summary
 CfgRank getAppRank()
          Application rank.
 CfgAppType getAppType()
          Type of the application this rank relates to.
 void setAppRank(CfgRank value)
          Application rank.
 void setAppType(CfgAppType value)
          Type of the application this rank relates to.
 
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgStructure
getParent, updateChildrenSavedState
 
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgBase
clone, ensureDataBackup, equals, flushChildrenContent, getConfigurationService, getData, getEndpoint, getLinkListCollection, getLinkValue, getLogger, getMetaData, getProperty, getProperty, getProperty, getRawObjectData, hashCode, initStruct, isSaved, lockObject, reloadObjectWithNewData, resolveLink, setProperty, toString, toStringProperties, toXml
 
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

CfgAppRank

public CfgAppRank(IConfService confService,
                  ConfStructure objData,
                  ICfgObject parent)
This constructor is intended for creation of structures from external or imported XML data. It is internally used by COM AB for objects and structures deserialization.

Parameters:
confService - configuration service instance
objData - configuration protocol structure data
parent - instance of configuration object as a parent for this structure instance

CfgAppRank

public CfgAppRank(IConfService confService,
                  org.w3c.dom.Node xmlData,
                  ICfgObject parent)
This constructor is intended for creation of structures from external or imported XML data. It is internally used by COM AB for objects and structures deserialization.

Parameters:
confService - configuration service instance
xmlData - XML object containing structure data
parent - instance of configuration object as a parent for this structure instance

CfgAppRank

public CfgAppRank(IConfService confService,
                  ICfgObject parent)
This constructor is intended for creation of detached objects.

Parameters:
confService - configuration service instance
parent - instance of configuration object as a parent for this structure instance
Method Detail

getAppType

public final CfgAppType getAppType()
Type of the application this rank relates to. May make sense for certain applications of the GUI type. (See CfgAppType and the comment below.) Mandatory. Once specified, cannot be changed. The same value cannot be repeated within one list.

Returns:
property value or null

setAppType

public final void setAppType(CfgAppType value)
Type of the application this rank relates to. May make sense for certain applications of the GUI type. (See CfgAppType and the comment below.) Mandatory. Once specified, cannot be changed. The same value cannot be repeated within one list.

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

getAppRank

public final CfgRank getAppRank()
Application rank. See type CfgRank . Rank CFGTenantAdministrator cannot be assigned to a person whose tenantDBID is 1. Ranks CFGServiceAdministrator and CFGSuperAdministrator cannot be assigned to a person whose tenantDBID is not 1. See type CfgRank.

Returns:
property value or null

setAppRank

public final void setAppRank(CfgRank value)
Application rank. See type CfgRank . Rank CFGTenantAdministrator cannot be assigned to a person whose tenantDBID is 1. Ranks CFGServiceAdministrator and CFGSuperAdministrator cannot be assigned to a person whose tenantDBID is not 1. See type CfgRank.

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

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.