Platform SDK Java 8.5 API Reference

com.genesyslab.platform.configuration.protocol.obj
Class ConfObjectBrief

java.lang.Object
  extended by com.genesyslab.platform.configuration.protocol.obj.ConfObjectBase
      extended by com.genesyslab.platform.configuration.protocol.obj.ConfObject
          extended by com.genesyslab.platform.configuration.protocol.obj.ConfObjectBrief
All Implemented Interfaces:
java.lang.Cloneable

public class ConfObjectBrief
extends ConfObject

Configuration object brief info structure is a kind of light weight view on existing configuration object.
It is designed for ability to read short "overview" information without loading of full configuration objects content.

Configuration server provides brief information on several types. At the moment it is about Tenant, Person and AccessGroup objects.

Configuration objects brief information may be available at EventBriefInfo by RequestGetBriefInfo protocol request.


Constructor Summary
ConfObjectBrief(CfgDescriptionObjectBriefInfo metadata)
          Constructor for creation of uninitialized brief object structure.
 
Method Summary
 java.lang.Integer getObjectDbid()
          Configuration objects DBID uniquely identifies configuration object of a particular type on particular configuration server.
 
Methods inherited from class com.genesyslab.platform.configuration.protocol.obj.ConfObject
getClassInfo, getObjectType
 
Methods inherited from class com.genesyslab.platform.configuration.protocol.obj.ConfObjectBase
checkTypeCompatibility, clone, createChildElement, equals, getAttributeInfo, getOrCreatePropertyValue, getPropertyInfo, getPropertyValue, getPropertyValue, hashCode, setPropertyValue, setPropertyValue, toString, toString, toStringContentHelper, toStringHelper
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ConfObjectBrief

public ConfObjectBrief(CfgDescriptionObjectBriefInfo metadata)
Constructor for creation of uninitialized brief object structure.

Parameters:
metadata - configuration brief object MetaData class.
Throws:
ConfObjectAttributeException - if given MetaData is null or there is some problem with its usage here.
Method Detail

getObjectDbid

public java.lang.Integer getObjectDbid()
Description copied from class: ConfObject
Configuration objects DBID uniquely identifies configuration object of a particular type on particular configuration server. It means that pair [object type, object DBID] uniquely specifies particular configuration object in configuration server database.

This value is been assigned by configuration server at moment of the object creation and can't be changed during its whole life cycle.

This method is a helper to find the DBID value in the object properties or properties of child structures depending on this object type.

Overrides:
getObjectDbid in class ConfObject
Returns:
configuration object DBID or null.

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.