Platform SDK Java 8.5 API Reference

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

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

public abstract class EventPlacedInQueue
extends Message

This event indicates that the interaction has been placed in a queue.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventPlacedInQueue create()
          Creates instance of EventPlacedInQueue with no parameters set.
static EventPlacedInQueue create(java.lang.Integer proxyClientId, java.lang.String oldQueue, java.util.Date eventTime, java.util.Date submittedToRouterAt, InteractionProperties interaction, ActorInfo actor, ReasonInfo reason, OldWorkbinInfo oldWorkbin, KeyValueCollection extension)
          Creates instance of EventPlacedInQueue with all parameters set.
static EventPlacedInQueue create(java.lang.String oldQueue, java.util.Date eventTime, InteractionProperties interaction, ActorInfo actor)
          Creates instance of EventPlacedInQueue with required parameters set.
abstract  ActorInfo getActor()
           
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.String getOldQueue()
          Defines queue the interaction was placed before.
abstract  OldWorkbinInfo getOldWorkbin()
           
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  java.util.Date getSubmittedToRouterAt()
          Date and time that the interaction was first submitted to the router.
abstract  void setActor(ActorInfo actor)
           
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 setOldQueue(java.lang.String oldQueue)
          Defines queue the interaction was placed before.
abstract  void setOldWorkbin(OldWorkbinInfo oldWorkbin)
           
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.
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 EventPlacedInQueue create()
Creates instance of EventPlacedInQueue with no parameters set.

Returns:
instance of EventPlacedInQueue

create

public static EventPlacedInQueue create(java.lang.Integer proxyClientId,
                                        java.lang.String oldQueue,
                                        java.util.Date eventTime,
                                        java.util.Date submittedToRouterAt,
                                        InteractionProperties interaction,
                                        ActorInfo actor,
                                        ReasonInfo reason,
                                        OldWorkbinInfo oldWorkbin,
                                        KeyValueCollection extension)
Creates instance of EventPlacedInQueue with all parameters set.

Parameters:
proxyClientId - The identifier of the client of proxy.
oldQueue - Defines queue the interaction was placed before.
eventTime - Date and time of the event.
submittedToRouterAt - Date and time, set by Interaction Server, the interaction has been submitted to router.
interaction - Interaction
actor - Actor
reason - Reason.
oldWorkbin - OldWorkbin
extension - Extensions.
Returns:
instance of EventPlacedInQueue

create

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

Parameters:
oldQueue - Defines queue the interaction was placed before.
eventTime - Date and time of the event.
interaction - Interaction
actor - Actor
Returns:
instance of EventPlacedInQueue

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.


getOldQueue

public abstract java.lang.String getOldQueue()
Defines queue the interaction was placed before.

Returns:
property value

setOldQueue

public abstract void setOldQueue(java.lang.String oldQueue)
Defines queue the interaction was placed before.

Parameters:
oldQueue - new value of the property

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.


getInteraction

public abstract InteractionProperties getInteraction()

setInteraction

public abstract void setInteraction(InteractionProperties interaction)

getActor

public abstract ActorInfo getActor()

setActor

public abstract void setActor(ActorInfo actor)

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).


getOldWorkbin

public abstract OldWorkbinInfo getOldWorkbin()

setOldWorkbin

public abstract void setOldWorkbin(OldWorkbinInfo oldWorkbin)

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.