Platform SDK Java 8.5 API Reference

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

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

public abstract class EventWorkbinContentChanged
extends Message

With this event, Interaction Server sends, to any agent application that has requested it, notification of change in the contents of a workbin.

Direction: From Interaction Server to agent application.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventWorkbinContentChanged create()
          Creates instance of EventWorkbinContentChanged with no parameters set.
static EventWorkbinContentChanged create(java.lang.Integer proxyClientId, InteractionOperation operation, WorkbinContentOperation workbinContentOperation, WorkbinInfo workbin, InteractionProperties interaction, ActorInfo actor, ReasonInfo reason, java.util.Date submittedToRouterAt, KeyValueCollection extension)
          Creates instance of EventWorkbinContentChanged with all parameters set.
static EventWorkbinContentChanged create(WorkbinInfo workbin)
          Creates instance of EventWorkbinContentChanged with required parameters set.
abstract  ActorInfo getActor()
           
abstract  KeyValueCollection getExtension()
          A key-value list of extensions.
abstract  InteractionProperties getInteraction()
           
abstract  InteractionOperation getOperation()
          Operation that led to this outcome: 8-timeout 10-stop 11-place in workbin 12-place in queue 13-disconnect
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  WorkbinInfo getWorkbin()
           
abstract  WorkbinContentOperation getWorkbinContentOperation()
          Direction of operation.
abstract  void setActor(ActorInfo actor)
           
abstract  void setExtension(KeyValueCollection extension)
          A key-value list of extensions.
abstract  void setInteraction(InteractionProperties interaction)
           
abstract  void setOperation(InteractionOperation operation)
          Operation that led to this outcome: 8-timeout 10-stop 11-place in workbin 12-place in queue 13-disconnect
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.
abstract  void setWorkbin(WorkbinInfo workbin)
           
abstract  void setWorkbinContentOperation(WorkbinContentOperation workbinContentOperation)
          Direction of operation.
 
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 EventWorkbinContentChanged create()
Creates instance of EventWorkbinContentChanged with no parameters set.

Returns:
instance of EventWorkbinContentChanged

create

public static EventWorkbinContentChanged create(java.lang.Integer proxyClientId,
                                                InteractionOperation operation,
                                                WorkbinContentOperation workbinContentOperation,
                                                WorkbinInfo workbin,
                                                InteractionProperties interaction,
                                                ActorInfo actor,
                                                ReasonInfo reason,
                                                java.util.Date submittedToRouterAt,
                                                KeyValueCollection extension)
Creates instance of EventWorkbinContentChanged with all parameters set.

Parameters:
proxyClientId - The identifier of the client of proxy.
operation - Operation code.
workbinContentOperation - Workbin content operation: 1 - specified interaction has been taken out of the workbin, 2 - specified interaction has been placed in the workbin.
workbin - Workbin
interaction - Interaction
actor - Actor
reason - Reason.
submittedToRouterAt - Date and time, set by Interaction Server, the interaction has been submitted to router.
extension - Extensions.
Returns:
instance of EventWorkbinContentChanged

create

public static EventWorkbinContentChanged create(WorkbinInfo workbin)
Creates instance of EventWorkbinContentChanged with required parameters set.

Parameters:
workbin - Workbin
Returns:
instance of EventWorkbinContentChanged

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.


getOperation

public abstract InteractionOperation getOperation()
Operation that led to this outcome:


setOperation

public abstract void setOperation(InteractionOperation operation)
Operation that led to this outcome:


getWorkbinContentOperation

public abstract WorkbinContentOperation getWorkbinContentOperation()
Direction of operation.


setWorkbinContentOperation

public abstract void setWorkbinContentOperation(WorkbinContentOperation workbinContentOperation)
Direction of operation.


getWorkbin

public abstract WorkbinInfo getWorkbin()

setWorkbin

public abstract void setWorkbin(WorkbinInfo workbin)

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


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:


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.