Platform SDK Java 8.5 API Reference

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

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

public abstract class RequestDistributeEvent
extends Message

The new request of the Interaction Server protocol allows clients to request the server to distribute custom reporting events to reporting clients based on current client registration and other rules applied to standard reporting events.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static RequestDistributeEvent create()
          Creates instance of RequestDistributeEvent with no parameters set.
static RequestDistributeEvent create(java.lang.Integer customEventId)
          Creates instance of RequestDistributeEvent with required parameters set.
static RequestDistributeEvent create(java.lang.Integer customEventId, java.lang.Integer proxyClientId, KeyValueCollection extension, java.lang.String mediaTypeName, KeyValueCollection eventContent, InteractionProperties interaction, PartyInfo party, ReasonInfo reason)
          Creates instance of RequestDistributeEvent with all parameters set.
abstract  java.lang.Integer getCustomEventId()
           
abstract  KeyValueCollection getEventContent()
           
abstract  KeyValueCollection getExtension()
          A key-value list of extensions.
abstract  InteractionProperties getInteraction()
           
abstract  java.lang.String getMediaTypeName()
          Media type name.
abstract  PartyInfo getParty()
           
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 setCustomEventId(int customEventId)
           
abstract  void setCustomEventId(java.lang.Integer customEventId)
           
abstract  void setEventContent(KeyValueCollection eventContent)
           
abstract  void setExtension(KeyValueCollection extension)
          A key-value list of extensions.
abstract  void setInteraction(InteractionProperties interaction)
           
abstract  void setMediaTypeName(java.lang.String mediaTypeName)
          Media type name.
abstract  void setParty(PartyInfo party)
           
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 RequestDistributeEvent create()
Creates instance of RequestDistributeEvent with no parameters set.

Returns:
instance of RequestDistributeEvent

create

public static RequestDistributeEvent create(java.lang.Integer customEventId,
                                            java.lang.Integer proxyClientId,
                                            KeyValueCollection extension,
                                            java.lang.String mediaTypeName,
                                            KeyValueCollection eventContent,
                                            InteractionProperties interaction,
                                            PartyInfo party,
                                            ReasonInfo reason)
Creates instance of RequestDistributeEvent with all parameters set.

Parameters:
customEventId -
proxyClientId - The identifier of the client of proxy.
extension - Extensions.
mediaTypeName - Name of the new media added.
eventContent -
interaction - Interaction
party - Party
reason - Reason.
Returns:
instance of RequestDistributeEvent

create

public static RequestDistributeEvent create(java.lang.Integer customEventId)
Creates instance of RequestDistributeEvent with required parameters set.

Parameters:
customEventId -
Returns:
instance of RequestDistributeEvent

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.


getCustomEventId

public abstract java.lang.Integer getCustomEventId()
Returns:
property value

setCustomEventId

public abstract void setCustomEventId(java.lang.Integer customEventId)
Parameters:
customEventId - new value of the property

setCustomEventId

public abstract void setCustomEventId(int customEventId)
Parameters:
customEventId - new value of the property

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:


getMediaTypeName

public abstract java.lang.String getMediaTypeName()
Media type name.


setMediaTypeName

public abstract void setMediaTypeName(java.lang.String mediaTypeName)
Media type name.


getEventContent

public abstract KeyValueCollection getEventContent()
Returns:
property value

setEventContent

public abstract void setEventContent(KeyValueCollection eventContent)
Parameters:
eventContent - new value of the property

getInteraction

public abstract InteractionProperties getInteraction()

setInteraction

public abstract void setInteraction(InteractionProperties interaction)

getParty

public abstract PartyInfo getParty()

setParty

public abstract void setParty(PartyInfo party)

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.