Platform SDK Java 8.5 API Reference

com.genesyslab.platform.openmedia.protocol.interactionserver.events
Class EventInteractionProperties

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.Message
          extended by com.genesyslab.platform.openmedia.protocol.interactionserver.events.EventInteractionProperties
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class EventInteractionProperties
extends Message

Retrives Interaction properties.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventInteractionProperties create()
          Creates instance of EventInteractionProperties with no parameters set.
static EventInteractionProperties create(java.lang.Integer proxyClientId, java.util.Date submittedToRouterAt, KeyValueCollection extension, InteractionProperties interaction)
          Creates instance of EventInteractionProperties with all parameters set.
abstract  KeyValueCollection getExtension()
          A key-value list of extensions.
abstract  InteractionProperties getInteraction()
           
abstract  java.lang.Integer getProxyClientId()
          Proxy client identifier.
abstract  java.lang.Integer getReferenceId()
          Reference identifier of the request.
abstract  java.util.Date getSubmittedToRouterAt()
          Date and time that the interaction was first submitted to the router.
abstract  void setExtension(KeyValueCollection extension)
          A key-value list of extensions.
abstract  void setInteraction(InteractionProperties interaction)
           
abstract  void setProxyClientId(int proxyClientId)
          Proxy client identifier.
abstract  void setProxyClientId(java.lang.Integer proxyClientId)
          Proxy client identifier.
abstract  void setReferenceId(int referenceId)
          Reference identifier of the request.
abstract  void setReferenceId(java.lang.Integer referenceId)
          Reference identifier of the request.
abstract  void setSubmittedToRouterAt(java.util.Date submittedToRouterAt)
          Date and time that the interaction was first submitted to the router.
 
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 EventInteractionProperties create()
Creates instance of EventInteractionProperties with no parameters set.

Returns:
instance of EventInteractionProperties

create

public static EventInteractionProperties create(java.lang.Integer proxyClientId,
                                                java.util.Date submittedToRouterAt,
                                                KeyValueCollection extension,
                                                InteractionProperties interaction)
Creates instance of EventInteractionProperties with all parameters set.

Parameters:
proxyClientId - The identifier of the client of proxy.
submittedToRouterAt - Date and time, set by Interaction Server, the interaction has been submitted to router.
extension - Extensions.
interaction - Interaction
Returns:
instance of EventInteractionProperties

getReferenceId

public abstract java.lang.Integer getReferenceId()
Reference identifier of the request. It is the client's responsibility to generate the reference identifier and then tie the server response to the request.


setReferenceId

public abstract void setReferenceId(java.lang.Integer referenceId)
Reference identifier of the request. It is the client's responsibility to generate the reference identifier and then tie the server response to the request.


setReferenceId

public abstract void setReferenceId(int referenceId)
Reference identifier of the request. It is the client's responsibility to generate the reference identifier and then tie the server response to the request.


getProxyClientId

public abstract java.lang.Integer getProxyClientId()
Proxy client identifier. Mandatory if client connects via proxy.


setProxyClientId

public abstract void setProxyClientId(java.lang.Integer proxyClientId)
Proxy client identifier. Mandatory if client connects via proxy.


setProxyClientId

public abstract void setProxyClientId(int proxyClientId)
Proxy client identifier. Mandatory if client connects via proxy.


getSubmittedToRouterAt

public abstract java.util.Date getSubmittedToRouterAt()
Date and time that the interaction was first submitted to the router.


setSubmittedToRouterAt

public abstract void setSubmittedToRouterAt(java.util.Date submittedToRouterAt)
Date and time that the interaction was first submitted to the router.


getExtension

public abstract KeyValueCollection getExtension()
A key-value list of extensions. For media servers the following extensions are defined, with values of type integer:


setExtension

public abstract void setExtension(KeyValueCollection extension)
A key-value list of extensions. For media servers the following extensions are defined, with values of type integer:


getInteraction

public abstract InteractionProperties getInteraction()

setInteraction

public abstract void setInteraction(InteractionProperties interaction)

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.