Platform SDK Java 8.5 API Reference

com.genesyslab.platform.voice.protocol.previewinteraction
Class PreviewInteractionBinding

java.lang.Object
  extended by com.genesyslab.platform.voice.protocol.previewinteraction.PreviewInteractionBinding

public final class PreviewInteractionBinding
extends java.lang.Object

Class contains functionality for marshaling/unmarshaling data between key value collection and appropriate object of predefined class. Predefined classes are generating according to protocol description.


Nested Class Summary
static class PreviewInteractionBinding.KVBindingException
           
 
Method Summary
static KeyValueCollection marshal(java.lang.Object obj)
          Marshal data from object of predefined class to key value collection.
static KeyValueCollection marshal(PreviewInteractionAcknowledge obj)
           
static KeyValueCollection marshal(PreviewInteractionBody obj)
           
static KeyValueCollection marshal(PreviewInteractionCancel obj)
           
static KeyValueCollection marshal(PreviewInteractionError obj)
           
static KeyValueCollection marshal(PreviewInteractionHeader obj)
           
static KeyValueCollection marshal(PreviewInteractionMessage obj)
           
static KeyValueCollection marshal(PreviewInteractionRequest obj)
           
static KeyValueCollection marshal(PreviewInteractionResponse obj)
           
static KeyValueCollection marshal(PreviewInteractionUserData obj)
           
static java.lang.String resolve(KeyValueCollection list)
          Resolve predefined class name according to key value collection Predefined classes are generating according to protocol description.
static boolean setProperty(PreviewInteractionAcknowledge obj, java.lang.String name, java.lang.Object value)
          Set property by name
static boolean setProperty(PreviewInteractionBody obj, java.lang.String name, java.lang.Object value)
          Set property by name
static boolean setProperty(PreviewInteractionCancel obj, java.lang.String name, java.lang.Object value)
          Set property by name
static boolean setProperty(PreviewInteractionError obj, java.lang.String name, java.lang.Object value)
          Set property by name
static boolean setProperty(PreviewInteractionHeader obj, java.lang.String name, java.lang.Object value)
          Set property by name
static boolean setProperty(PreviewInteractionMessage obj, java.lang.String name, java.lang.Object value)
          Set property by name
static boolean setProperty(PreviewInteractionRequest obj, java.lang.String name, java.lang.Object value)
          Set property by name
static boolean setProperty(PreviewInteractionResponse obj, java.lang.String name, java.lang.Object value)
          Set property by name
static boolean setProperty(PreviewInteractionUserData obj, java.lang.String name, java.lang.Object value)
          Set property by name
static java.lang.Object unmarshal(KeyValueCollection kvlist)
          Actually will be called unmarshal(resolve(kvlist), kvlist).
static java.lang.Object unmarshal(java.lang.String className, KeyValueCollection kvlist)
          Unmarshal data from key value collection to appropriate object of predefined class.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

marshal

public static KeyValueCollection marshal(java.lang.Object obj)
                                  throws PreviewInteractionBinding.KVBindingException
Marshal data from object of predefined class to key value collection. This method simply route to class specific marshal. Predefined classes are generating according to protocol description.

Parameters:
obj - object for which must be generated according key value collection that will be represent it data
Returns:
key value collection that represent passed object or null (if object not supported)
Throws:
PreviewInteractionBinding.KVBindingException

unmarshal

public static java.lang.Object unmarshal(KeyValueCollection kvlist)
                                  throws PreviewInteractionBinding.KVBindingException
Actually will be called unmarshal(resolve(kvlist), kvlist). Unmarshal data from key value collection to appropriate object of predefined class. Predefined classes are generating according to protocol description.

Parameters:
kvlist - key value collection for which must be generated appropriate object of predefined class
Returns:
object of predefined class that represent value collection passed as argument or null (if unknown class name or fail resolve class name)
Throws:
PreviewInteractionBinding.KVBindingException

unmarshal

public static java.lang.Object unmarshal(java.lang.String className,
                                         KeyValueCollection kvlist)
                                  throws PreviewInteractionBinding.KVBindingException
Unmarshal data from key value collection to appropriate object of predefined class. Predefined classes are generating according to protocol description.

Parameters:
className - name of predefined class used as tergat for binding.
kvlist - key value collection for which must be generated appropriate object of predefined class
Returns:
object of predefined class that represent value collection passed as argument or null (if unknown class name or fail resolve class name)
Throws:
PreviewInteractionBinding.KVBindingException

resolve

public static java.lang.String resolve(KeyValueCollection list)
Resolve predefined class name according to key value collection Predefined classes are generating according to protocol description. This function generated according to protocol description.

Parameters:
KeyValueCollection - key value collection for which must be resolved predefined class name
Returns:
predefined class name or null

marshal

public static KeyValueCollection marshal(PreviewInteractionUserData obj)
                                  throws PreviewInteractionBinding.KVBindingException
Throws:
PreviewInteractionBinding.KVBindingException

setProperty

public static boolean setProperty(PreviewInteractionUserData obj,
                                  java.lang.String name,
                                  java.lang.Object value)
                           throws java.lang.ClassCastException
Set property by name

Parameters:
obj - object in which will be set property
name - property name to set
value - new property value
Returns:
true if success, false if property with assigned name doesn't exit
Throws:
java.lang.ClassCastException

marshal

public static KeyValueCollection marshal(PreviewInteractionMessage obj)
                                  throws PreviewInteractionBinding.KVBindingException
Throws:
PreviewInteractionBinding.KVBindingException

setProperty

public static boolean setProperty(PreviewInteractionMessage obj,
                                  java.lang.String name,
                                  java.lang.Object value)
                           throws java.lang.ClassCastException
Set property by name

Parameters:
obj - object in which will be set property
name - property name to set
value - new property value
Returns:
true if success, false if property with assigned name doesn't exit
Throws:
java.lang.ClassCastException

marshal

public static KeyValueCollection marshal(PreviewInteractionHeader obj)
                                  throws PreviewInteractionBinding.KVBindingException
Throws:
PreviewInteractionBinding.KVBindingException

setProperty

public static boolean setProperty(PreviewInteractionHeader obj,
                                  java.lang.String name,
                                  java.lang.Object value)
                           throws java.lang.ClassCastException
Set property by name

Parameters:
obj - object in which will be set property
name - property name to set
value - new property value
Returns:
true if success, false if property with assigned name doesn't exit
Throws:
java.lang.ClassCastException

marshal

public static KeyValueCollection marshal(PreviewInteractionBody obj)
                                  throws PreviewInteractionBinding.KVBindingException
Throws:
PreviewInteractionBinding.KVBindingException

setProperty

public static boolean setProperty(PreviewInteractionBody obj,
                                  java.lang.String name,
                                  java.lang.Object value)
                           throws java.lang.ClassCastException
Set property by name

Parameters:
obj - object in which will be set property
name - property name to set
value - new property value
Returns:
true if success, false if property with assigned name doesn't exit
Throws:
java.lang.ClassCastException

marshal

public static KeyValueCollection marshal(PreviewInteractionError obj)
                                  throws PreviewInteractionBinding.KVBindingException
Throws:
PreviewInteractionBinding.KVBindingException

setProperty

public static boolean setProperty(PreviewInteractionError obj,
                                  java.lang.String name,
                                  java.lang.Object value)
                           throws java.lang.ClassCastException
Set property by name

Parameters:
obj - object in which will be set property
name - property name to set
value - new property value
Returns:
true if success, false if property with assigned name doesn't exit
Throws:
java.lang.ClassCastException

marshal

public static KeyValueCollection marshal(PreviewInteractionRequest obj)
                                  throws PreviewInteractionBinding.KVBindingException
Throws:
PreviewInteractionBinding.KVBindingException

setProperty

public static boolean setProperty(PreviewInteractionRequest obj,
                                  java.lang.String name,
                                  java.lang.Object value)
                           throws java.lang.ClassCastException
Set property by name

Parameters:
obj - object in which will be set property
name - property name to set
value - new property value
Returns:
true if success, false if property with assigned name doesn't exit
Throws:
java.lang.ClassCastException

marshal

public static KeyValueCollection marshal(PreviewInteractionResponse obj)
                                  throws PreviewInteractionBinding.KVBindingException
Throws:
PreviewInteractionBinding.KVBindingException

setProperty

public static boolean setProperty(PreviewInteractionResponse obj,
                                  java.lang.String name,
                                  java.lang.Object value)
                           throws java.lang.ClassCastException
Set property by name

Parameters:
obj - object in which will be set property
name - property name to set
value - new property value
Returns:
true if success, false if property with assigned name doesn't exit
Throws:
java.lang.ClassCastException

marshal

public static KeyValueCollection marshal(PreviewInteractionAcknowledge obj)
                                  throws PreviewInteractionBinding.KVBindingException
Throws:
PreviewInteractionBinding.KVBindingException

setProperty

public static boolean setProperty(PreviewInteractionAcknowledge obj,
                                  java.lang.String name,
                                  java.lang.Object value)
                           throws java.lang.ClassCastException
Set property by name

Parameters:
obj - object in which will be set property
name - property name to set
value - new property value
Returns:
true if success, false if property with assigned name doesn't exit
Throws:
java.lang.ClassCastException

marshal

public static KeyValueCollection marshal(PreviewInteractionCancel obj)
                                  throws PreviewInteractionBinding.KVBindingException
Throws:
PreviewInteractionBinding.KVBindingException

setProperty

public static boolean setProperty(PreviewInteractionCancel obj,
                                  java.lang.String name,
                                  java.lang.Object value)
                           throws java.lang.ClassCastException
Set property by name

Parameters:
obj - object in which will be set property
name - property name to set
value - new property value
Returns:
true if success, false if property with assigned name doesn't exit
Throws:
java.lang.ClassCastException

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.