Platform SDK Java 8.5 API Reference

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

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

public abstract class EventPropertiesChanged
extends Message

This event is sent to agent applications, media servers, URS, and reporting engines to indicate that interaction properties of the specified interaction have been changed.

Direction: From Interaction Server to clients.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventPropertiesChanged create()
          Creates instance of EventPropertiesChanged with no parameters set.
static EventPropertiesChanged create(java.util.Date eventTime, InteractionProperties interaction, ActorInfo actor)
          Creates instance of EventPropertiesChanged with required parameters set.
static EventPropertiesChanged create(java.lang.Integer proxyClientId, KeyValueCollection addedProperties, KeyValueCollection changedProperties, KeyValueCollection deletedProperties, java.util.Date eventTime, java.util.Date submittedToRouterAt, KeyValueCollection extension, InteractionProperties interaction, ActorInfo actor)
          Creates instance of EventPropertiesChanged with all parameters set.
abstract  ActorInfo getActor()
           
abstract  KeyValueCollection getAddedProperties()
          List of properties added.
abstract  KeyValueCollection getChangedProperties()
          List of properties changed.
abstract  KeyValueCollection getDeletedProperties()
          List of properties deleted.
abstract  java.util.Date getEventTime()
          Date and time of the event.
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 setActor(ActorInfo actor)
           
abstract  void setAddedProperties(KeyValueCollection addedProperties)
          List of properties added.
abstract  void setChangedProperties(KeyValueCollection changedProperties)
          List of properties changed.
abstract  void setDeletedProperties(KeyValueCollection deletedProperties)
          List of properties deleted.
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 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 EventPropertiesChanged create()
Creates instance of EventPropertiesChanged with no parameters set.

Returns:
instance of EventPropertiesChanged

create

public static EventPropertiesChanged create(java.lang.Integer proxyClientId,
                                            KeyValueCollection addedProperties,
                                            KeyValueCollection changedProperties,
                                            KeyValueCollection deletedProperties,
                                            java.util.Date eventTime,
                                            java.util.Date submittedToRouterAt,
                                            KeyValueCollection extension,
                                            InteractionProperties interaction,
                                            ActorInfo actor)
Creates instance of EventPropertiesChanged with all parameters set.

Parameters:
proxyClientId - The identifier of the client of proxy.
addedProperties - List of properties to change.
changedProperties - List of properties to change. Note that since Interaction Server does not allow duplicated properties, the lists of added and changed are treated the same way.
deletedProperties - List of properties to delete.
eventTime - Date and time of the event.
submittedToRouterAt - Date and time, set by Interaction Server, the interaction has been submitted to router.
extension - Extensions.
interaction - Interaction
actor - Actor
Returns:
instance of EventPropertiesChanged

create

public static EventPropertiesChanged create(java.util.Date eventTime,
                                            InteractionProperties interaction,
                                            ActorInfo actor)
Creates instance of EventPropertiesChanged with required parameters set.

Parameters:
eventTime - Date and time of the event.
interaction - Interaction
actor - Actor
Returns:
instance of EventPropertiesChanged

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.


getAddedProperties

public abstract KeyValueCollection getAddedProperties()
List of properties added.


setAddedProperties

public abstract void setAddedProperties(KeyValueCollection addedProperties)
List of properties added.


getChangedProperties

public abstract KeyValueCollection getChangedProperties()
List of properties changed.


setChangedProperties

public abstract void setChangedProperties(KeyValueCollection changedProperties)
List of properties changed.


getDeletedProperties

public abstract KeyValueCollection getDeletedProperties()
List of properties deleted.


setDeletedProperties

public abstract void setDeletedProperties(KeyValueCollection deletedProperties)
List of properties deleted.


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.


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)

getActor

public abstract ActorInfo getActor()

setActor

public abstract void setActor(ActorInfo actor)

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.