|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.commons.protocol.DataObject
com.genesyslab.platform.commons.protocol.Message
com.genesyslab.platform.openmedia.protocol.interactionserver.events.EventExternalServiceResponded
public abstract class EventExternalServiceResponded
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 notification of activity from an ESP server,
it copies all of the information in that notification into this event, which
it then sends to the reporting engine. The event also contains additional
information about the client that requested the service, a timestamp, and so on.
This event can be sent to the reporting engine only, and only if the reporting
engine has registered to receive external service activity events either for a
specific ESP server or for all ESP servers.
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static EventExternalServiceResponded |
create()
Creates instance of EventExternalServiceResponded with no parameters set. |
static EventExternalServiceResponded |
create(java.lang.Integer espClientRefid,
java.lang.Integer espServerRefid,
java.lang.Integer proxyClientId,
java.lang.Integer espResponseType,
KeyValueCollection espRequestEnvelope,
KeyValueCollection userData,
java.util.Date eventTime,
java.lang.String espRequestId,
ActorInfo actor,
KeyValueCollection extension)
Creates instance of EventExternalServiceResponded 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 |
getEspResponseType()
|
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 |
setEspResponseType(int espResponseType)
|
abstract void |
setEspResponseType(java.lang.Integer espResponseType)
|
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 |
---|
public static final int ID
public static final java.lang.String NAME
Method Detail |
---|
public static EventExternalServiceResponded create()
public static EventExternalServiceResponded create(java.lang.Integer espClientRefid, java.lang.Integer espServerRefid, java.lang.Integer proxyClientId, java.lang.Integer espResponseType, KeyValueCollection espRequestEnvelope, KeyValueCollection userData, java.util.Date eventTime, java.lang.String espRequestId, ActorInfo actor, KeyValueCollection extension)
espClientRefid
- Reference identifier of the original request to ESP serverespServerRefid
- Reference identifier of the request to ESP server generated by Interaction ServerproxyClientId
- The identifier of the client of proxy.espResponseType
- 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
- Actorextension
- Extensions.
public abstract java.lang.Integer getReferenceId()
public abstract void setReferenceId(java.lang.Integer referenceId)
public abstract void setReferenceId(int referenceId)
public abstract java.lang.Integer getEspClientRefid()
public abstract void setEspClientRefid(java.lang.Integer espClientRefid)
public abstract void setEspClientRefid(int espClientRefid)
public abstract java.lang.Integer getEspServerRefid()
public abstract void setEspServerRefid(java.lang.Integer espServerRefid)
public abstract void setEspServerRefid(int espServerRefid)
public abstract java.lang.Integer getProxyClientId()
public abstract void setProxyClientId(java.lang.Integer proxyClientId)
public abstract void setProxyClientId(int proxyClientId)
public abstract java.lang.Integer getEspResponseType()
public abstract void setEspResponseType(java.lang.Integer espResponseType)
espResponseType
- new value of the propertypublic abstract void setEspResponseType(int espResponseType)
espResponseType
- new value of the propertypublic abstract KeyValueCollection getEspRequestEnvelope()
public abstract void setEspRequestEnvelope(KeyValueCollection espRequestEnvelope)
public abstract KeyValueCollection getUserData()
public abstract void setUserData(KeyValueCollection userData)
public abstract java.util.Date getEventTime()
public abstract void setEventTime(java.util.Date eventTime)
public abstract java.lang.String getEspRequestId()
public abstract void setEspRequestId(java.lang.String espRequestId)
public abstract ActorInfo getActor()
public abstract void setActor(ActorInfo actor)
public abstract KeyValueCollection getExtension()
public abstract void setExtension(KeyValueCollection extension)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |