Platform SDK Java 8.5 API Reference

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

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

public abstract class EventExternalServiceRequested
extends Message

This event provides the means to report external service activity-that is, activity by an ESP server such as classification, acknowledgements, autoresponses, and so on.

When Interaction Server receives an ESP request from a client, it copies all of the information in the request into this event, which it then sends to the reporting engine. The event also contains a timestamp and additional information about the client that requested the service.

This event can be sent to the reporting engine only, and only if the reporting engine has registered to receive external service activity events for at least one ESP server.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventExternalServiceRequested create()
          Creates instance of EventExternalServiceRequested with no parameters set.
static EventExternalServiceRequested create(java.lang.Integer espClientRefid, java.lang.Integer espServerRefid, java.lang.Integer proxyClientId, KeyValueCollection espRequestEnvelope, KeyValueCollection userData, java.util.Date eventTime, java.lang.String espRequestId, ActorInfo actor, KeyValueCollection extension)
          Creates instance of EventExternalServiceRequested with all parameters set.
abstract  ActorInfo getActor()
           
abstract  java.lang.Integer getEspClientRefid()
          Reference identifier of the original request to ESP server, generated by the ESP client (for example, Universal Routing Server).
abstract  KeyValueCollection getEspRequestEnvelope()
          The contents of Extensions.Envelope3rdServer from the ESP request.
abstract  java.lang.String getEspRequestId()
          [Optional: Earlier versions of Interaction Server do not send this attribute.] The unique identifier of the ESP transaction, as generated by Interaction Server.
abstract  java.lang.Integer getEspServerRefid()
          Identifier of the request to ESP server, generated by Interaction Server.
abstract  java.util.Date getEventTime()
          Date and time of the event.
abstract  KeyValueCollection getExtension()
          A key-value list of extensions.
abstract  java.lang.Integer getProxyClientId()
          Proxy client identifier.
abstract  java.lang.Integer getReferenceId()
          Reference identifier of the request.
abstract  KeyValueCollection getUserData()
          Pointer to any user data that should be attached to the interaction.
abstract  void setActor(ActorInfo actor)
           
abstract  void setEspClientRefid(int espClientRefid)
          Reference identifier of the original request to ESP server, generated by the ESP client (for example, Universal Routing Server).
abstract  void setEspClientRefid(java.lang.Integer espClientRefid)
          Reference identifier of the original request to ESP server, generated by the ESP client (for example, Universal Routing Server).
abstract  void setEspRequestEnvelope(KeyValueCollection espRequestEnvelope)
          The contents of Extensions.Envelope3rdServer from the ESP request.
abstract  void setEspRequestId(java.lang.String espRequestId)
          [Optional: Earlier versions of Interaction Server do not send this attribute.] The unique identifier of the ESP transaction, as generated by Interaction Server.
abstract  void setEspServerRefid(int espServerRefid)
          Identifier of the request to ESP server, generated by Interaction Server.
abstract  void setEspServerRefid(java.lang.Integer espServerRefid)
          Identifier of the request to ESP server, generated by Interaction Server.
abstract  void setEventTime(java.util.Date eventTime)
          Date and time of the event.
abstract  void setExtension(KeyValueCollection extension)
          A key-value list of extensions.
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 setUserData(KeyValueCollection userData)
          Pointer to any user data that should be attached to the interaction.
 
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 EventExternalServiceRequested create()
Creates instance of EventExternalServiceRequested with no parameters set.

Returns:
instance of EventExternalServiceRequested

create

public static EventExternalServiceRequested create(java.lang.Integer espClientRefid,
                                                   java.lang.Integer espServerRefid,
                                                   java.lang.Integer proxyClientId,
                                                   KeyValueCollection espRequestEnvelope,
                                                   KeyValueCollection userData,
                                                   java.util.Date eventTime,
                                                   java.lang.String espRequestId,
                                                   ActorInfo actor,
                                                   KeyValueCollection extension)
Creates instance of EventExternalServiceRequested with all parameters set.

Parameters:
espClientRefid - Reference identifier of the original request to ESP server
espServerRefid - Reference identifier of the request to ESP server generated by Interaction Server
proxyClientId - The identifier of the client of proxy.
espRequestEnvelope -
userData - Any interaction related data.
eventTime - Date and time of the event.
espRequestId - [optional; earlier versions of Interaction Server, obviously, do not send this attribute] Unique identifier of the ESP transaction. Generated by Interaction Server. Correspondent events contain the same id.
actor - Actor
extension - Extensions.
Returns:
instance of EventExternalServiceRequested

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.


getEspClientRefid

public abstract java.lang.Integer getEspClientRefid()
Reference identifier of the original request to ESP server, generated by the ESP client (for example, Universal Routing Server).


setEspClientRefid

public abstract void setEspClientRefid(java.lang.Integer espClientRefid)
Reference identifier of the original request to ESP server, generated by the ESP client (for example, Universal Routing Server).


setEspClientRefid

public abstract void setEspClientRefid(int espClientRefid)
Reference identifier of the original request to ESP server, generated by the ESP client (for example, Universal Routing Server).


getEspServerRefid

public abstract java.lang.Integer getEspServerRefid()
Identifier of the request to ESP server, generated by Interaction Server.


setEspServerRefid

public abstract void setEspServerRefid(java.lang.Integer espServerRefid)
Identifier of the request to ESP server, generated by Interaction Server.


setEspServerRefid

public abstract void setEspServerRefid(int espServerRefid)
Identifier of the request to ESP server, generated by Interaction Server.


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.


getEspRequestEnvelope

public abstract KeyValueCollection getEspRequestEnvelope()
The contents of Extensions.Envelope3rdServer from the ESP request. Contains the relevant values from the Extensions of the ESP message Request3rdServer, shown below.


setEspRequestEnvelope

public abstract void setEspRequestEnvelope(KeyValueCollection espRequestEnvelope)
The contents of Extensions.Envelope3rdServer from the ESP request. Contains the relevant values from the Extensions of the ESP message Request3rdServer, shown below.


getUserData

public abstract KeyValueCollection getUserData()
Pointer to any user data that should be attached to the interaction.


setUserData

public abstract void setUserData(KeyValueCollection userData)
Pointer to any user data that should be attached to the interaction.


getEventTime

public abstract java.util.Date getEventTime()
Date and time of the event.


setEventTime

public abstract void setEventTime(java.util.Date eventTime)
Date and time of the event.


getEspRequestId

public abstract java.lang.String getEspRequestId()
[Optional: Earlier versions of Interaction Server do not send this attribute.] The unique identifier of the ESP transaction, as generated by Interaction Server. All corresponding events contain the same ID.


setEspRequestId

public abstract void setEspRequestId(java.lang.String espRequestId)
[Optional: Earlier versions of Interaction Server do not send this attribute.] The unique identifier of the ESP transaction, as generated by Interaction Server. All corresponding events contain the same ID.


getActor

public abstract ActorInfo getActor()

setActor

public abstract void setActor(ActorInfo actor)

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:


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.