Configuration Platform SDK 7.6 API Reference

Uses of Class
com.genesyslab.platform.commons.collections.KeyValueCollection

Packages that use KeyValueCollection
com.genesyslab.platform.commons.collections Contains classes that allow you to use Genesys Key-Value collections in your applications. 
com.genesyslab.platform.commons.connection Provides facilities for communicating with Genesys servers. 
com.genesyslab.platform.commons.connection.configuration   
com.genesyslab.platform.configuration.protocol.confserver.requests.objects This package contains the Request Object classes that your applications can use to work with objects in the Genesys Configuration Layer.

To use these classes, you will need to supply information about the objects you want to work with. 
 

Uses of KeyValueCollection in com.genesyslab.platform.commons.collections
 

Methods in com.genesyslab.platform.commons.collections that return KeyValueCollection
static KeyValueCollection TKVXmlSerializer.deserialize(org.w3c.dom.Document listDocument)
           
static KeyValueCollection TKVXmlSerializer.deserialize(org.w3c.dom.Element listElement)
           
static KeyValueCollection TKVSerializer.deserialize(java.io.InputStream in)
          Reads packed TKV list from OutputStream and unpacks it.
static KeyValueCollection TKVSerializer.deserialize(java.io.InputStream in, java.lang.String encoding, boolean readLen)
          Reads packed TKV list from OutputStream and unpacks it.
static KeyValueCollection TKVSerializer.deserialize(byte[] bytes)
          Unpacks TKV list from byte array.
static KeyValueCollection TKVSerializer.deserialize(byte[] bytes, boolean getLen)
          Unpacks TKV list from byte array.
static KeyValueCollection TKVSerializer.deserialize(byte[] bytes, java.lang.String encoding)
          Unpacks TKV list from byte array.
static KeyValueCollection TKVSerializer.deserialize(byte[] bytes, java.lang.String encoding, boolean getLen)
          Unpacks TKV list from byte array.
static KeyValueCollection TKVSerializer.deserialize(byte[] bytes, java.lang.String encoding, int offset, int length, boolean readLen)
          Unpacks TKV list from byte array.
 KeyValueCollection KeyValuePair.getTKVValue()
          Return TKVList value of the Pair or null if the value is not TKVList.
 KeyValueCollection KeyValueCollection.getList(java.lang.String key)
          Return list value stored with specified key.
 

Methods in com.genesyslab.platform.commons.collections with parameters of type KeyValueCollection
static org.w3c.dom.Document TKVXmlSerializer.serialize(KeyValueCollection list)
           
static org.w3c.dom.Element TKVXmlSerializer.serialize(KeyValueCollection list, org.w3c.dom.Document nodeFactory)
           
static byte[] TKVSerializer.getBytes(KeyValueCollection list)
          Packs the list and returns it as byte array.
 void KeyValuePair.setTKVValue(KeyValueCollection val)
          Set value of this Pair to TKVList
 void KeyValueCollection.addList(java.lang.String key, KeyValueCollection list)
          Add TKV list to this list under specified key.
 

Constructors in com.genesyslab.platform.commons.collections with parameters of type KeyValueCollection
KeyValuePair(java.lang.String key, KeyValueCollection value)
          Create Pair with TKV data.
 

Uses of KeyValueCollection in com.genesyslab.platform.commons.connection
 

Methods in com.genesyslab.platform.commons.connection that return KeyValueCollection
 KeyValueCollection ConnectionMessage.getKeyValueCollection(int id)
          Get KeyValueCollection attribute value from the Message by ID.
 KeyValueCollection ConnectionMessage.getKeyValueCollection(int id, java.lang.String encoding)
          Get KeyValueCollection attribute value from the Message by ID.
 

Methods in com.genesyslab.platform.commons.connection with parameters of type KeyValueCollection
 void ConnectionMessage.add(int id, KeyValueCollection val)
          Add KeyValueCollection attribute to this message.
 void ConnectionMessage.add(int id, KeyValueCollection val, java.lang.String encoding)
          Add KeyValueCollection attribute to this message.
 

Uses of KeyValueCollection in com.genesyslab.platform.commons.connection.configuration
 

Constructors in com.genesyslab.platform.commons.connection.configuration with parameters of type KeyValueCollection
KeyValueConfiguration(KeyValueCollection list)
          Creates object and set all configuration using given KeyValueCollection object.
 

Uses of KeyValueCollection in com.genesyslab.platform.configuration.protocol.confserver.requests.objects
 

Methods in com.genesyslab.platform.configuration.protocol.confserver.requests.objects that return KeyValueCollection
abstract  KeyValueCollection RequestUpdateObject.getParameters()
          TKVList containing additional parameters (if needed)
abstract  KeyValueCollection RequestUnregisterNotification.getSubscription()
          Two-dimensional TKVList containing lists with the following properties (the names of the keys on the first level are disregarded – let them just be unique): object_type - type of the objects to receive notifications on (if equals to 0 – means all the object types), tenant_id - Tenant affiliation of the objects to receive notifications on (if equals to 0 – means all the Tenants), object_dbid - DBID of the specific object to receive notifications on (used in conjunction with object_type), exclude_bytecode - if set, Configuration Server will filter out binary userProperties field 'bytecode' from notifications.
abstract  KeyValueCollection RequestRegisterNotification.getSubscription()
          Two-dimensional TKVList containing lists with the following properties (the names of the keys on the first level are disregarded – let them just be unique): object_type - type of the objects to receive notifications on (if equals to 0 – means all the object types), tenant_id - Tenant affiliation of the objects to receive notifications on (if equals to 0 – means all the Tenants), object_dbid - DBID of the specific object to receive notifications on (used in conjunction with object_type), exclude_bytecode - if set, Configuration Server will filter out binary userProperties field 'bytecode' from notifications.
abstract  KeyValueCollection RequestReadObjects.getFilter()
          Filters are structured as key-value pairs where the value of each key defines a certain condition of data selection.
abstract  KeyValueCollection RequestDeleteObject.getParameters()
          TKVList containing additional parameters (if needed)
abstract  KeyValueCollection RequestCreateObject.getParameters()
          TKVList containing additional parameters (if needed)
 

Methods in com.genesyslab.platform.configuration.protocol.confserver.requests.objects with parameters of type KeyValueCollection
static RequestUpdateObject RequestUpdateObject.create(java.lang.Integer objectType, org.w3c.dom.Document confObject, KeyValueCollection parameters)
          Creates instance of RequestUpdateObject with all parameters set.
abstract  void RequestUpdateObject.setParameters(KeyValueCollection parameters)
          TKVList containing additional parameters (if needed)
static RequestUnregisterNotification RequestUnregisterNotification.create(KeyValueCollection subscription)
          Creates instance of RequestUnregisterNotification with all parameters set.
abstract  void RequestUnregisterNotification.setSubscription(KeyValueCollection subscription)
          Two-dimensional TKVList containing lists with the following properties (the names of the keys on the first level are disregarded – let them just be unique): object_type - type of the objects to receive notifications on (if equals to 0 – means all the object types), tenant_id - Tenant affiliation of the objects to receive notifications on (if equals to 0 – means all the Tenants), object_dbid - DBID of the specific object to receive notifications on (used in conjunction with object_type), exclude_bytecode - if set, Configuration Server will filter out binary userProperties field 'bytecode' from notifications.
static RequestRegisterNotification RequestRegisterNotification.create(KeyValueCollection subscription)
          Creates instance of RequestRegisterNotification with all parameters set.
abstract  void RequestRegisterNotification.setSubscription(KeyValueCollection subscription)
          Two-dimensional TKVList containing lists with the following properties (the names of the keys on the first level are disregarded – let them just be unique): object_type - type of the objects to receive notifications on (if equals to 0 – means all the object types), tenant_id - Tenant affiliation of the objects to receive notifications on (if equals to 0 – means all the Tenants), object_dbid - DBID of the specific object to receive notifications on (used in conjunction with object_type), exclude_bytecode - if set, Configuration Server will filter out binary userProperties field 'bytecode' from notifications.
static RequestReadObjects RequestReadObjects.create(java.lang.Integer objectType, KeyValueCollection filter)
          Creates instance of RequestReadObjects with all parameters set.
abstract  void RequestReadObjects.setFilter(KeyValueCollection filter)
          Filters are structured as key-value pairs where the value of each key defines a certain condition of data selection.
static RequestDeleteObject RequestDeleteObject.create(java.lang.Integer objectType, java.lang.Integer dbid, KeyValueCollection parameters)
          Creates instance of RequestDeleteObject with all parameters set.
abstract  void RequestDeleteObject.setParameters(KeyValueCollection parameters)
          TKVList containing additional parameters (if needed)
static RequestCreateObject RequestCreateObject.create(java.lang.Integer objectType, org.w3c.dom.Document confObject, KeyValueCollection parameters)
          Creates instance of RequestCreateObject with all parameters set.
abstract  void RequestCreateObject.setParameters(KeyValueCollection parameters)
          TKVList containing additional parameters (if needed)
 


Configuration Platform SDK 7.6 API Reference

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