Platform SDK Java 8.5 API Reference

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

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.EventObjectsRead
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class EventObjectsRead
extends Message

Returns information about objects in the Genesys Configuration Layer. The information you asked for is returned by invoking the getConfObject() method or the getObjects() method of the EventObjectsRead message. The getConfObject() method returns an Document representation of the object. The getObjects() method returns ConfObjectsCollection representation of configuration server objects collection. Both methods return the same information about objects in the Genesys Configuration Layer, however ConfObjectsCollection is more lightweight representation of the objects comparing to XML. The getConfObject() method sample:


 EventObjectsRead objectsRead =
     (EventObjectsRead) theMessage;
 System.out.println(theMessage.messageName());
 System.out.println("There are "
       + objectsRead.getObjectTotalCount() + " objects of this type.");
 Document resultDocument =
    (Document) objectsRead.getConfObject();
 


The getObjects() method sample:


 EventObjectsRead objectsRead =
    (EventObjectsRead) theMessage;
 ConfObjectsCollection objects = objectsRead.getObjects();
 if (objects != null) {
    for (ConfObject obj : objects) {
      System.out.println("Got " + obj.getObjectType() + " object \""
               + obj.getPropertyValue("name")
               + "\", dbid = " + obj.getObjectDbid());
    }
 }
 
It is important to note that Configuration Server may send more than one of these messages in response to your request, depending on how much data needs to be returned. Your application must be ready to handle all of these messages. Your application also needs to process the EventObjectsSent message that Configuration Server will send to indicate that it has finished providing the data you requested.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventObjectsRead create()
          Creates instance of EventObjectsRead with no parameters set.
static EventObjectsRead create(java.lang.Integer objectType, java.lang.Integer objectCount, org.w3c.dom.Document confObject, java.lang.Integer objectTotalCount)
          Deprecated. Use new configuration server structures instead of DOM.
static EventObjectsRead create(java.lang.Integer objectType, java.lang.Integer objectCount, org.w3c.dom.Document confObject, java.lang.Integer objectTotalCount, java.lang.String[] objectPaths, long[] folderDbids, java.lang.String format)
          Deprecated. Use new configuration server structures instead of DOM.
abstract  org.w3c.dom.Document getConfObject()
          Deprecated. Use new configuration server structures instead of DOM.
abstract  long[] getFolderDbids()
          Array of unique identifiers of objects' folders
abstract  java.lang.String getFormat()
          None
abstract  java.lang.Integer getObjectCount()
          Number of objects matching requested criteria
abstract  java.lang.String[] getObjectPaths()
          Configuration objects' path array
abstract  ConfObjectsCollection getObjects()
          ConfObjectsCollection representation of configuration server objects collection
abstract  java.lang.Integer getObjectTotalCount()
          Total 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 setConfObject(org.w3c.dom.Document confObject)
          Deprecated. Use new configuration server structures instead of DOM.
abstract  void setFolderDbids(long[] folderDbids)
          Array of unique identifiers of objects' folders
abstract  void setFormat(java.lang.String format)
          None
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 setObjectPaths(java.lang.String[] objectPaths)
          Configuration objects' path array
abstract  void setObjects(ConfObjectsCollection objects)
          ConfObjectsCollection representation of configuration server objects collection
abstract  void setObjectTotalCount(int objectTotalCount)
          Total number of objects matching requested criteria
abstract  void setObjectTotalCount(java.lang.Integer objectTotalCount)
          Total 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 EventObjectsRead create()
Creates instance of EventObjectsRead with no parameters set.

Returns:
instance of EventObjectsRead

create

public static EventObjectsRead create(java.lang.Integer objectType,
                                      java.lang.Integer objectCount,
                                      org.w3c.dom.Document confObject,
                                      java.lang.Integer objectTotalCount,
                                      java.lang.String[] objectPaths,
                                      long[] folderDbids,
                                      java.lang.String format)
Deprecated. Use new configuration server structures instead of DOM.

Creates instance of EventObjectsRead.

Parameters:
objectType - Type of configuration object as defined in ConfServerObject enum
objectCount - Number of objects matching requested criteria
confObject - XmlDocumentV7 representation of cfglib object(s)
objectTotalCount - Total number of objects matching requested criteria
objectPaths - Configuration objects' path array
folderDbids - Array of unique identifiers of objects' folders
format - None
Returns:
instance of EventObjectsRead

create

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

Creates instance of EventObjectsRead.

Parameters:
objectType - Type of configuration object as defined in ConfServerObject enum
objectCount - Number of objects matching requested criteria
confObject - XmlDocumentV7 representation of cfglib object(s)
objectTotalCount - Total number of objects matching requested criteria
Returns:
instance of EventObjectsRead

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

getConfObject

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

XmlDocumentV7 representation of cfglib object(s)

Returns:
property value

setConfObject

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

XmlDocumentV7 representation of cfglib object(s)

Parameters:
confObject - new value of the property

getObjects

public abstract ConfObjectsCollection getObjects()
ConfObjectsCollection representation of configuration server objects collection

Returns:
property value

setObjects

public abstract void setObjects(ConfObjectsCollection objects)
ConfObjectsCollection representation of configuration server objects collection

Parameters:
objects - new value of the property

getObjectTotalCount

public abstract java.lang.Integer getObjectTotalCount()
Total number of objects matching requested criteria

Returns:
property value

setObjectTotalCount

public abstract void setObjectTotalCount(java.lang.Integer objectTotalCount)
Total number of objects matching requested criteria

Parameters:
objectTotalCount - new value of the property

setObjectTotalCount

public abstract void setObjectTotalCount(int objectTotalCount)
Total number of objects matching requested criteria

Parameters:
objectTotalCount - new value of the property

getObjectPaths

public abstract java.lang.String[] getObjectPaths()
Configuration objects' path array

Returns:
property value

setObjectPaths

public abstract void setObjectPaths(java.lang.String[] objectPaths)
Configuration objects' path array

Parameters:
objectPaths - new value of the property

getFolderDbids

public abstract long[] getFolderDbids()
Array of unique identifiers of objects' folders

Returns:
property value

setFolderDbids

public abstract void setFolderDbids(long[] folderDbids)
Array of unique identifiers of objects' folders

Parameters:
folderDbids - new value of the property

getFormat

public abstract java.lang.String getFormat()
None

Returns:
property value

setFormat

public abstract void setFormat(java.lang.String format)
None

Parameters:
format - 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.