Platform SDK Java 8.5 API Reference

com.genesyslab.platform.configuration.protocol.confserver.events
Class EventBriefInfo

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.Message
          extended by com.genesyslab.platform.configuration.protocol.confserver.events.EventBriefInfo
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class EventBriefInfo
extends Message


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventBriefInfo create()
          Creates instance of EventBriefInfo with no parameters set.
static EventBriefInfo create(java.lang.Integer objectType, java.lang.Integer objectCount, org.w3c.dom.Document briefInfo)
          Deprecated. Use new configuration server structures instead of DOM.
abstract  org.w3c.dom.Document getBriefInfo()
          Deprecated. Use new configuration server structures instead of DOM.
abstract  ConfObjectBrief getBriefObject()
          ConfObjectBrief representation of configuration server object brief info structure
abstract  java.lang.Integer getObjectCount()
          Number of objects matching requested criteria
abstract  java.lang.Integer getObjectType()
          Type of configuration object as defined in ConfServerObject enum
abstract  java.lang.Integer getReferenceId()
          Reference ID to connect response to request.
abstract  void setBriefInfo(org.w3c.dom.Document briefInfo)
          Deprecated. Use new configuration server structures instead of DOM.
abstract  void setBriefObject(ConfObjectBrief briefObject)
          ConfObjectBrief representation of configuration server object brief info structure
abstract  void setObjectCount(int objectCount)
          Number of objects matching requested criteria
abstract  void setObjectCount(java.lang.Integer objectCount)
          Number of objects matching requested criteria
abstract  void setObjectType(int objectType)
          Type of configuration object as defined in ConfServerObject enum
abstract  void setObjectType(java.lang.Integer objectType)
          Type of configuration object as defined in ConfServerObject enum
abstract  void setReferenceId(int referenceId)
          Reference ID to connect response to request.
abstract  void setReferenceId(java.lang.Integer referenceId)
          Reference ID to connect response to request.
 
Methods inherited from class com.genesyslab.platform.commons.protocol.Message
cloneMessage, getEndpoint, getMessageAttribute, getProtocolDescription, getProtocolId, messageId, messageName, setProtocolDescription
 
Methods inherited from class com.genesyslab.platform.commons.protocol.DataObject
equals, hashCode, toString, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

ID

public static final int ID
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
See Also:
Constant Field Values
Method Detail

create

public static EventBriefInfo create()
Creates instance of EventBriefInfo with no parameters set.

Returns:
instance of EventBriefInfo

create

public static EventBriefInfo create(java.lang.Integer objectType,
                                    java.lang.Integer objectCount,
                                    org.w3c.dom.Document briefInfo)
Deprecated. Use new configuration server structures instead of DOM.

Creates instance of EventBriefInfo.

Parameters:
objectType - Type of configuration object as defined in ConfServerObject enum
objectCount - Number of objects matching requested criteria
briefInfo - XmlDocumentV6 representation of cfglib object(s)
Returns:
instance of EventBriefInfo

getReferenceId

public abstract java.lang.Integer getReferenceId()
Reference ID to connect response to request. If set to 0, it means that ReferenceID should be assigned by ReferenceBuilder.


setReferenceId

public abstract void setReferenceId(java.lang.Integer referenceId)
Reference ID to connect response to request. If set to 0, it means that ReferenceID should be assigned by ReferenceBuilder.


setReferenceId

public abstract void setReferenceId(int referenceId)
Reference ID to connect response to request. If set to 0, it means that ReferenceID should be assigned by ReferenceBuilder.


getObjectType

public abstract java.lang.Integer getObjectType()
Type of configuration object as defined in ConfServerObject enum

Returns:
property value

setObjectType

public abstract void setObjectType(java.lang.Integer objectType)
Type of configuration object as defined in ConfServerObject enum

Parameters:
objectType - new value of the property

setObjectType

public abstract void setObjectType(int objectType)
Type of configuration object as defined in ConfServerObject enum

Parameters:
objectType - new value of the property

getObjectCount

public abstract java.lang.Integer getObjectCount()
Number of objects matching requested criteria

Returns:
property value

setObjectCount

public abstract void setObjectCount(java.lang.Integer objectCount)
Number of objects matching requested criteria

Parameters:
objectCount - new value of the property

setObjectCount

public abstract void setObjectCount(int objectCount)
Number of objects matching requested criteria

Parameters:
objectCount - new value of the property

getBriefInfo

@Deprecated
public abstract org.w3c.dom.Document getBriefInfo()
Deprecated. Use new configuration server structures instead of DOM.

XmlDocumentV6 representation of cfglib object(s)

Returns:
property value

setBriefInfo

@Deprecated
public abstract void setBriefInfo(org.w3c.dom.Document briefInfo)
Deprecated. Use new configuration server structures instead of DOM.

XmlDocumentV6 representation of cfglib object(s)

Parameters:
briefInfo - new value of the property

getBriefObject

public abstract ConfObjectBrief getBriefObject()
ConfObjectBrief representation of configuration server object brief info structure

Returns:
property value

setBriefObject

public abstract void setBriefObject(ConfObjectBrief briefObject)
ConfObjectBrief representation of configuration server object brief info structure

Parameters:
briefObject - new value of the property

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.