Platform SDK Java 8.5 API Reference

com.genesyslab.platform.openmedia.protocol.interactionserver.requests.interactionmanagement
Class RequestStopProcessing

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.requests.interactionmanagement.RequestStopProcessing
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class RequestStopProcessing
extends Message

With this request, a media server, agent application, or URS can stop interaction processing and delete the interaction from the Interaction Server database. The interaction history remains available in UCS after processing stops.

If one of the parties (agent or strategy) or a media server requests that processing of an interaction be stopped, the interaction is revoked from all other parties participating in processing.

There are the following limitations:

Direction: From media server, agent application, or URS to Interaction Server.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestStopProcessing create()
          Creates instance of RequestStopProcessing with no parameters set.
static RequestStopProcessing create(java.lang.Integer proxyClientId, KeyValueCollection extension, java.lang.String interactionId, ReasonInfo reason)
          Creates instance of RequestStopProcessing with all parameters set.
static RequestStopProcessing create(java.lang.String interactionId, ReasonInfo reason)
          Creates instance of RequestStopProcessing with required parameters set.
abstract  KeyValueCollection getExtension()
          A key-value list of extensions.
abstract  java.lang.String getInteractionId()
          Identifier of the interaction being accepted.
abstract  java.lang.Integer getProxyClientId()
          Proxy client identifier.
abstract  ReasonInfo getReason()
          This property has been deprecated in all events.
abstract  java.lang.Integer getReferenceId()
          Reference identifier of the request.
abstract  void setExtension(KeyValueCollection extension)
          A key-value list of extensions.
abstract  void setInteractionId(java.lang.String interactionId)
          Identifier of the interaction being accepted.
abstract  void setProxyClientId(int proxyClientId)
          Proxy client identifier.
abstract  void setProxyClientId(java.lang.Integer proxyClientId)
          Proxy client identifier.
abstract  void setReason(ReasonInfo reason)
          This property has been deprecated in all events.
abstract  void setReferenceId(int referenceId)
          Reference identifier of the request.
abstract  void setReferenceId(java.lang.Integer referenceId)
          Reference identifier of the request.
 
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 RequestStopProcessing create()
Creates instance of RequestStopProcessing with no parameters set.

Returns:
instance of RequestStopProcessing

create

public static RequestStopProcessing create(java.lang.Integer proxyClientId,
                                           KeyValueCollection extension,
                                           java.lang.String interactionId,
                                           ReasonInfo reason)
Creates instance of RequestStopProcessing with all parameters set.

Parameters:
proxyClientId - The identifier of the client of proxy.
extension - Extensions.
interactionId - Interaction identifier.
reason - Reason.
Returns:
instance of RequestStopProcessing

create

public static RequestStopProcessing create(java.lang.String interactionId,
                                           ReasonInfo reason)
Creates instance of RequestStopProcessing with required parameters set.

Parameters:
interactionId - Interaction identifier.
reason - Reason.
Returns:
instance of RequestStopProcessing

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.


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:


getInteractionId

public abstract java.lang.String getInteractionId()
Identifier of the interaction being accepted.


setInteractionId

public abstract void setInteractionId(java.lang.String interactionId)
Identifier of the interaction being accepted.


getReason

public abstract ReasonInfo getReason()
This property has been deprecated in all events. In any messages sent to Interaction Server, this value must be left as 0 (the default value).


setReason

public abstract void setReason(ReasonInfo reason)
This property has been deprecated in all events. In any messages sent to Interaction Server, this value must be left as 0 (the default value).


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.