Configuration Platform SDK 7.6 API Reference

com.genesyslab.platform.configuration.protocol.confserver.requests.objects
Class RequestReadObjects

java.lang.Object
  extended bycom.genesyslab.platform.commons.protocol.DataObject
      extended bycom.genesyslab.platform.commons.protocol.Message
          extended bycom.genesyslab.platform.configuration.protocol.confserver.requests.objects.RequestReadObjects
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class RequestReadObjects
extends Message

A request to obtain information about objects in the Genesys Configuration Layer. To use this request, you need to create a KeyValueCollection that allows you to supply information about the objects you want to get information about. If you want to ask about all of the objects of a particular type in your configuration layer, you can leave this filter key empty. Otherwise, you will need to supply information that identifies the objects you are interested in, such as the name of an agent, as shown here:


 KeyValueCollection filterKey = new KeyValueCollection();
 filterKey.addObject("user_name", agentUserName);
 
Now you are ready to create the request. If you want to get information about an agent, you need to specify its object type as a Person, which is the object type used by Configuration Server for agents. Here is how to do that:


 ConfServerObjectType objectType = ConfServerObjectType.Person;
 int intPerson = objectType.asInteger();
 RequestReadObjects requestReadObjects =
 	RequestReadObjects.create(
 		intPerson,
 		filterKey);
 
After you have created your request, you can send it to Configuration Server, as shown here:


 confServerProtocol.send(requestReadObjects);
 
If the request is successful, you will receive one or more EventObjectsRead messages, depending on how much data Configuration Server needs to send. Once the server has finished sending this data, it will send an EventObjectsSent message, which confirms that it has finished.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestReadObjects create()
          Creates instance of RequestReadObjects with no parameters set.
static RequestReadObjects create(java.lang.Integer objectType, KeyValueCollection filter)
          Creates instance of RequestReadObjects with all parameters set.
abstract  KeyValueCollection getFilter()
          Filters are structured as key-value pairs where the value of each key defines a certain condition of data selection.
abstract  java.lang.Integer getObjectType()
          Type of configuration object as defined in ConfServerObject enum
abstract  java.lang.Integer getReferenceId()
          Reference id to connect responce to request.
abstract  void setFilter(KeyValueCollection filter)
          Filters are structured as key-value pairs where the value of each key defines a certain condition of data selection.
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 responce to request.
abstract  void setReferenceId(java.lang.Integer referenceId)
          Reference id to connect responce to request.
 
Methods inherited from class com.genesyslab.platform.commons.protocol.Message
cloneMessage, getEndpoint, getMessageAttribute, getProtocolDescription, getProtocolId, messageId, messageName
 
Methods inherited from class com.genesyslab.platform.commons.protocol.DataObject
equals, hashCode, toString, toString
 
Methods inherited from class java.lang.Object
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 RequestReadObjects create()
Creates instance of RequestReadObjects with no parameters set.

Returns:
instance of RequestReadObjects

create

public static RequestReadObjects create(java.lang.Integer objectType,
                                        KeyValueCollection filter)
Creates instance of RequestReadObjects with all parameters set.

Parameters:
objectType - Type of configuration object as defined in ConfServerObject enum
filter - Filters are structured as key-value pairs where the value of each key defines a certain condition of data selection. Filter keys are defined as variables of integer type unless otherwise noted
Returns:
instance of RequestReadObjects

getReferenceId

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

Returns:
property value

setReferenceId

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

Parameters:
referenceId - new value of the property

setReferenceId

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

Parameters:
referenceId - new value of the property

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

getFilter

public abstract KeyValueCollection getFilter()
Filters are structured as key-value pairs where the value of each key defines a certain condition of data selection. Filter keys are defined as variables of integer type unless otherwise noted

Returns:
property value

setFilter

public abstract void setFilter(KeyValueCollection filter)
Filters are structured as key-value pairs where the value of each key defines a certain condition of data selection. Filter keys are defined as variables of integer type unless otherwise noted

Parameters:
filter - new value of the property

Configuration Platform SDK 7.6 API Reference

Send comments on this topic.
Copyright © 2006–2008 Genesys Telecommunication Laboratories, Inc. All rights reserved.